#36762: Added See link to FieldFetchBlocked exception documentation
-------------------------------------+-------------------------------------
Reporter: Mohit Sharma | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: dev | Severity: Normal
Keywords: documentation | Triage Stage:
exceptions FieldFetchBlocked | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
== Problem ==
The `FieldFetchBlocked` exception documentation in
`docs/ref/exceptions.txt` is missing a "See" link to related
documentation, unlike other exceptions in the same file.
== Location ==
`docs/ref/exceptions.txt`, line 173-176
== Current Documentation ==
.. exception:: FieldFetchBlocked
Raised when a field would be fetched on-demand and the
:attr:`~django.db.models.RAISE` fetch mode is active.== Solution ==
Add a "See" link to the fetch modes documentation, following the pattern
used by other exceptions like `ObjectDoesNotExist` and `ObjectNotUpdated`.
== Patch ==
I have a patch ready that adds:
See :doc:`/topics/db/fetch-modes` for more information about fetch
modes.This helps users find more detailed information about fetch modes
and when `FieldFetchBlocked` is raised.
== Solution ==
Add a "See" link to the fetch modes documentation, following the pattern
used by other exceptions like ObjectDoesNotExist and ObjectNotUpdated.
== Patch ==
I have a patch ready that adds:
See :doc:`/topics/db/fetch-modes` for more information about fetch
modes.
This helps users find more detailed information about fetch modes and when
FieldFetchBlocked is raised.
--
Ticket URL: <https://code.djangoproject.com/ticket/36762>
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 visit
https://groups.google.com/d/msgid/django-updates/0107019adcddc288-84d2415a-182a-4be3-948e-49bd04d70aca-000000%40eu-central-1.amazonses.com.
