Code

Opened 2 years ago

Closed 16 months 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

Attachments (0)

Change History (2)

comment:1 Changed 2 years ago by aaugustin

  • Easy pickings unset
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Design decision needed
  • Type changed from Bug to New feature

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

comment:2 Changed 16 months ago by aaugustin

  • Resolution set to wontfix
  • Status changed from new to 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.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.