Opened 3 weeks ago
Closed 3 weeks ago
#36762 closed Cleanup/optimization (wontfix)
Added See link to FieldFetchBlocked exception documentation
| Reported by: | Mohit Sharma | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | documentation exceptions FieldFetchBlocked |
| Cc: | Mohit Sharma | Triage Stage: | Unreviewed |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
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.RAISEfetch 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-modesfor more information about fetch modes.This helps users find more detailed information about fetch modes and whenFieldFetchBlockedis 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-modesfor more information about fetch modes.
This helps users find more detailed information about fetch modes and when FieldFetchBlocked is raised.
Change History (3)
comment:2 by , 3 weeks ago
comment:3 by , 3 weeks ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → closed |
Thanks, but I think it's okay as is -- we already link to the RAISE fetch mode, which is the same document you're proposing to link to.
Pull request created: https://github.com/django/django/pull/20356