Opened 4 years ago

Closed 4 years ago

#18502 closed New feature (wontfix)

django.forms.models.fields_for_model() missing from online docs

Reported by: cberzan@… 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 Changed 4 years ago by Aymeric Augustin

Easy pickings: unset
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedDesign decision needed
Type: BugNew feature

That would mean making it a public API, with all the consequences in terms of stability and backwards-compatibility commitment.

comment:2 Changed 4 years ago by Aymeric Augustin

Resolution: wontfix
Status: newclosed

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.
Back to Top