#36524: EmailMessage method documentation cannot be cross referenced
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 5.2 | Severity: Normal
Keywords: email | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
The documentation for EmailMessage does not use standard Sphinx `method::`
directives for methods like `message()` and `attach()`. This makes it
difficult to create references to those methods elsewhere in the
documentation (e.g., in release notes). (Compare with docs for the
EmailMultiAlternatives subclass, which ''do'' use method directives.)
We should update docs/topics/email.txt to use method directives for all
EmailMessage methods.
(I probably ''wouldn't'' change the EmailMessage options like `to` and
`body` to use `attribute::` directives. I think that would create
confusion about constructor params vs attributes, which are handled
reasonably well by the existing approach. And I don't think it's common to
link to individual options.)
--
Ticket URL: <https://code.djangoproject.com/ticket/36524>
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/010701983d536835-72f0c415-6eb0-44bb-8272-8c4b328fe7b1-000000%40eu-central-1.amazonses.com.
