[Django] #36591: Remove unnecessary dotted paths in email docs

[Django]

#36591: Remove unnecessary dotted paths in email docs
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Type:
| Cleanup/optimization
Status: new | Component:
| Uncategorized
Version: 5.2 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
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.)
--
Ticket URL: <https://code.djangoproject.com/ticket/36591>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36591: Remove unnecessary dotted paths in email docs

--------------------------------------+------------------------------------
Reporter: Mike Edmunds | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):

* component: Uncategorized => Documentation
* easy: 0 => 1
* stage: Unreviewed => Accepted
* version: 5.2 => dev

--
Ticket URL: <https://code.djangoproject.com/ticket/36591#comment:1>

[Django]

#36591: Remove unnecessary dotted paths in email docs

-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner:
Type: | DaniFornons
Cleanup/optimization | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by DaniFornons):

* owner: (none) => DaniFornons
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36591#comment:2>

[Django]

#36591: Remove unnecessary dotted paths in email docs
-------------------------------------+-------------------------------------

Reporter: Mike Edmunds | Owner: Dani
Type: | Fornons

Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Dani Fornons):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36591#comment:3>

[Django]

#36591: Remove unnecessary dotted paths in email docs
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner: Dani
Type: | Fornons
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mike Edmunds):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36591#comment:4>

[Django]

#36591: Remove unnecessary dotted paths in email docs
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner: Dani
Type: | Fornons

Cleanup/optimization | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"014be2f0dabb1eea4748df528edf65878dcfdecc" 014be2f0]:
{{{#!CommitTicketReference repository=""
revision="014be2f0dabb1eea4748df528edf65878dcfdecc"
Fixed #36591 -- Removed unnecessary dotted paths in email docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36591#comment:5>