Changes between Initial Version and Version 1 of Ticket #32957


Ignore:
Timestamp:
Jul 21, 2021, 1:07:30 PM (3 years ago)
Author:
Chris Jerdonek
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #32957 – Description

    initial v1  
    11Currently, in the documentation of [https://docs.djangoproject.com/en/3.2/ref/models/instances/#saving-objects 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 [https://docs.djangoproject.com/en/3.2/ref/models/instances/#specifying-which-fields-to-save "Specifying which fields to save"].
    22
    3 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 of the argument can be found.
     3I 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.
Back to Top