Opened 12 years ago
Closed 11 years ago
#18502 closed New feature (wontfix)
django.forms.models.fields_for_model() missing from online docs
| Reported by: | Owned by: | nobody | |
|---|---|---|---|
| Component: | Documentation | Version: | 1.4 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Design decision needed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The fields_for_model() function is exported in django.forms.models, and has a nice docstring. It is useful e.g. for building custom Forms that combine fields from multiple models. Is there a reason why this function is not mentioned anywhere in the online docs?
https://docs.djangoproject.com/search/?q=fields_for_model&release=1
Change History (2)
comment:1 by , 12 years ago
| Easy pickings: | unset |
|---|---|
| Triage Stage: | Unreviewed → Design decision needed |
| Type: | Bug → New feature |
comment:2 by , 11 years ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → closed |
I've looked into documenting this function, and it doesn't really fit anywhere in the docs. It isn't an API.
It's really designed as an implementation detail, and I'd prefer to keep it as such.
Note:
See TracTickets
for help on using tickets.
That would mean making it a public API, with all the consequences in terms of stability and backwards-compatibility commitment.