#32957: Make documentation of Model.save() arguments easier to find and get to
-------------------------------------+-------------------------------------
Reporter: Chris Jerdonek | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by Chris Jerdonek:
Old description:
> Currently, 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"].
>
> 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.
New description:
Currently, 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"].
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.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/32957#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.a445323b7b705969bde6bce813ac5965%40djangoproject.com.
