Opened 3 years ago
Last modified 3 years ago
#32957 closed Cleanup/optimization
Make documentation of Model.save() arguments easier to find and get to — at Version 1
Reported by: | Chris Jerdonek | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description (last modified by )
Currently, in the documentation of Model.save(), one needs to scroll far down to find documentation of the keyword arguments. For example, for the update_fields
argument, one has to scroll down to a section called Specifying which fields to save.
I think it would be helpful if, right after Model.save()
's function signature in the docs, there was a sentence or two containing a link to the right section, for each keyword argument argument appearing in the signature. I'm thinking of sentences like, "For documentation of the force_insert
and force_update
arguments, see the "Forcing an INSERT or UPDATE" section. ..." This will make it clearer where the documentation for the arguments can be found.