This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: email subpackages documentation problems
Type: behavior Stage: resolved
Components: Documentation, email Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: adam.woodbeck, barry, docs@python, eric.araujo, python-dev, r.david.murray, ysj.ray
Priority: normal Keywords: patch

Created on 2011-04-06 15:57 by ysj.ray, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
email_subpackages_document_problems.diff ysj.ray, 2011-04-06 15:57 review
Messages (9)
msg133143 - (view) Author: ysj.ray (ysj.ray) Date: 2011-04-06 15:57
All the module name in the first line of email subpackages' documentation files(Doc/library/email.xxx.rst) are incorrect: all of them are "email" but not "email.xxx"

Besides, the Doc/library/email-examples.rst is not a module and it uses ":mod:`email`: xxx"
msg133144 - (view) Author: ysj.ray (ysj.ray) Date: 2011-04-06 16:01
And this causes the toctree in email doc(http://docs.python.org/dev/library/email.html) in correct. All of the tree elements' names are displayed as "email".
msg133316 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-04-08 15:45
See also http://sphinx.pocoo.org/domains.html#directive-py:currentmodule
msg133317 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-04-08 15:46
> Besides, the Doc/library/email-examples.rst is not a module and it
> uses ":mod:`email`: xxx"

Not a problem.  “:mod:” is not “.. module::”.  See above link.
msg133951 - (view) Author: ysj.ray (ysj.ray) Date: 2011-04-18 03:40
Oh, sorry, I didn't differ :mod:, :module:, :currentmodule: clearly.

But shouldn't the modules link titles in http://docs.python.org/dev/library/email.html display correct module names instead just the "email" package name?
"""email: Representing character sets""" seems a little wearied.
msg133979 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-04-18 16:21
Sure, +1 on using the submodule name in the module or currentmodule directive.
msg161731 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-05-27 21:10
New changeset 64e82c4f4e10 by R David Murray in branch 'default':
#11785: fix the :mod: references in email package submodule titles.
http://hg.python.org/cpython/rev/64e82c4f4e10
msg161734 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-05-27 21:18
New changeset df59aefdb1c8 by R David Murray in branch '2.7':
#11785: fix the :mod: references in email package submodule titles.
http://hg.python.org/cpython/rev/df59aefdb1c8

New changeset 6737c2ca98ee by R David Murray in branch '3.2':
#11785: fix the :mod: references in email package submodule titles.
http://hg.python.org/cpython/rev/6737c2ca98ee
msg161735 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2012-05-27 21:19
Fixed.
History
Date User Action Args
2022-04-11 14:57:15adminsetgithub: 55994
2012-05-27 21:19:41r.david.murraysetstatus: open -> closed
resolution: fixed
messages: + msg161735

stage: resolved
2012-05-27 21:18:46python-devsetmessages: + msg161734
2012-05-27 21:10:47python-devsetnosy: + python-dev
messages: + msg161731
2012-05-24 03:17:02r.david.murraysetversions: + Python 2.7, - Python 3.1
nosy: + barry

assignee: r.david.murray ->
components: + email
type: behavior
2011-05-28 19:55:49adam.woodbecksetnosy: + adam.woodbeck
2011-04-18 16:21:28eric.araujosetmessages: + msg133979
2011-04-18 03:40:44ysj.raysetmessages: + msg133951
2011-04-08 15:46:14eric.araujosetmessages: + msg133317
2011-04-08 15:45:35eric.araujosetnosy: + eric.araujo
messages: + msg133316
2011-04-06 20:58:47r.david.murraysetassignee: docs@python -> r.david.murray
2011-04-06 16:01:40ysj.raysetmessages: + msg133144
2011-04-06 16:01:11r.david.murraysetnosy: + r.david.murray
2011-04-06 15:57:37ysj.raycreate