[Django] #36329: Remove/replace non-code custom link text when cross-referencing Python objects in docs

5 views
Skip to first unread message

Django

unread,
Apr 16, 2025, 9:04:01 AM4/16/25
to django-...@googlegroups.com
#36329: Remove/replace non-code custom link text when cross-referencing Python
objects in docs
-------------------------------------+-------------------------------------
Reporter: Clifford | Owner: Clifford Gama
Gama |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: dev
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Some cross-references to Python objects in the docs use custom link text
that isn't actual code, eg :meth:`a get lookup
<django.models.QuerySet.get>`
[https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/#django.contrib.contenttypes.models.ContentType.get_object_for_this_type
here]. This is undesirable because it causes natural language phrases like
"a get lookup", in this example, to render as inline code.
--
Ticket URL: <https://code.djangoproject.com/ticket/36329>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Apr 16, 2025, 9:10:13 AM4/16/25
to django-...@googlegroups.com
#36329: Remove/replace non-code custom link text when cross-referencing Python
objects in docs
-------------------------------------+-------------------------------------
Reporter: Clifford Gama | Owner: Clifford
Type: | Gama
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Clifford Gama):

* has_patch: 0 => 1

Comment:

[https://github.com/django/django/pull/19386 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/36329#comment:1>
Reply all
Reply to author
Forward
0 new messages