Opened 2 hours ago

Last modified 87 minutes ago

#36762 new Cleanup/optimization

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.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.

Change History (2)

comment:1 by Mohit Sharma, 92 minutes ago

Version 0, edited 92 minutes ago by Mohit Sharma (next)
Note: See TracTickets for help on using tickets.
Back to Top