Issue 11785: email subpackages documentation problems (original) (raw)
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) *  |
Date: 2011-04-08 15:45 |
| See also http://sphinx.pocoo.org/domains.html#directive-py:currentmodule | ||
| msg133317 - (view) | Author: Éric Araujo (eric.araujo) * |
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) * |
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)  |
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) |
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) * |
Date: 2012-05-27 21:19 |
| Fixed. |
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:57:15 | admin | set | github: 55994 |
| 2012-05-27 21:19:41 | r.david.murray | set | status: open -> closedresolution: fixedmessages: + stage: resolved |
| 2012-05-27 21🔞46 | python-dev | set | messages: + |
| 2012-05-27 21:10:47 | python-dev | set | nosy: + python-devmessages: + |
| 2012-05-24 03:17:02 | r.david.murray | set | versions: + Python 2.7, - Python 3.1nosy: + barryassignee: r.david.murray -> components: + emailtype: behavior |
| 2011-05-28 19:55:49 | adam.woodbeck | set | nosy: + adam.woodbeck |
| 2011-04-18 16:21:28 | eric.araujo | set | messages: + |
| 2011-04-18 03:40:44 | ysj.ray | set | messages: + |
| 2011-04-08 15:46:14 | eric.araujo | set | messages: + |
| 2011-04-08 15:45:35 | eric.araujo | set | nosy: + eric.araujomessages: + |
| 2011-04-06 20:58:47 | r.david.murray | set | assignee: docs@python -> r.david.murray |
| 2011-04-06 16:01:40 | ysj.ray | set | messages: + |
| 2011-04-06 16:01:11 | r.david.murray | set | nosy: + r.david.murray |
| 2011-04-06 15:57:37 | ysj.ray | create |