#36570: Remove ":py" domain from roles
-------------------------------------+-------------------------------------
Reporter: Tim Graham | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: dev | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
In the documentation source files, there's some confusion about roles like
{{{:py:class:`email.message.EmailMessage`}}}. In this case, `py` indicates
the Python language [https://www.sphinx-
doc.org/en/master/usage/domains/index.html domain] (which means any code
written in Python, not Python built-ins in particular).
Since the Python domain is the default in Sphinx, you can omit the `:py`
prefix when referring to Python objects, for example, using `:class:`
instead of `:py:class:`.
Including `:py` ensures clarity and avoids ambiguity if other domains are
also in use., but since the Django documentation doesn't use other domains
(C++, JavaScript, etc.), I see no reason to include the prefix.
--
Ticket URL: <https://code.djangoproject.com/ticket/36570>
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/01070198e1593985-9431c01d-a717-4eb5-8b1d-c0724732c4a4-000000%40eu-central-1.amazonses.com.
