Opened 3 weeks ago

Closed 9 days ago

#36591 closed Cleanup/optimization (fixed)

Remove unnecessary dotted paths in email docs

Reported by: Mike Edmunds Owned by: Dani Fornons
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

In docs/topics/email.txt, there are several references like this:

... :class:`~django.core.mail.EmailMessage` ...

But throughout that file, django.core.mail is the default module (due to the module:: django.core.mail directive at the top). This has exactly the same meaning, and is shorter (which would improve wrapping):

... :class:`EmailMessage` ...

The full dotted path is only necessary when you specifically want it to appear in the generated docs. And starting a reference with ~ character means "omit the full dotted path—just show the last component."

(Also applies to :func: and :meth: and any other inline Sphinx roles in email.txt. We could probably just remove~django.core.mail.—with the leading ~—throughout that file.)

Change History (5)

comment:1 by Tim Graham, 3 weeks ago

Component: Uncategorized → Documentation
Easy pickings: set
Triage Stage: Unreviewed → Accepted
Version: 5.2 → dev

comment:2 by Dani Fornons, 3 weeks ago

Owner: set to Dani Fornons
Status: new → assigned

comment:3 by Dani Fornons, 3 weeks ago

Has patch: set
Last edited 3 weeks ago by Dani Fornons (previous) (diff)

comment:4 by Mike Edmunds, 2 weeks ago

Triage Stage: Accepted → Ready for checkin

comment:5 by Mariusz Felisiak <felisiak.mariusz@…>, 9 days ago

Resolution: → fixed
Status: assigned → closed

In 014be2f0:

Fixed #36591 -- Removed unnecessary dotted paths in email docs.

Note: See TracTickets for help on using tickets.
Back to Top