Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#32957 closed Cleanup/optimization (fixed)

Make documentation of Model.save() arguments easier to find and get to

Reported by: Chris Jerdonek Owned by: Abhyudai
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 Chris Jerdonek)

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.

Change History (7)

comment:1 by Chris Jerdonek, 3 years ago

Description: modified (diff)

comment:2 by Mariusz Felisiak, 3 years ago

Triage Stage: UnreviewedAccepted

comment:3 by Abhyudai, 3 years ago

Owner: changed from nobody to Abhyudai
Status: newassigned

comment:4 by Abhyudai, 3 years ago

Has patch: set

comment:5 by Mariusz Felisiak, 3 years ago

Triage Stage: AcceptedReady for checkin

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

Resolution: fixed
Status: assignedclosed

In f876c7d0:

Fixed #32957 -- Improved visibility of arguments sections in Model.save() docs.

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

In bdd4cbe8:

[3.2.x] Fixed #32957 -- Improved visibility of arguments sections in Model.save() docs.

Backport of f876c7d08e75d719df5cd34b97cac63fdaae3fcc from main

Note: See TracTickets for help on using tickets.
Back to Top