Issue 17270: make the section header doc convention more clearly optional (original) (raw)
Issue17270
➜
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.
This issue has been migrated to GitHub: https://github.com/python/cpython/issues/61472
classification
| Title: | make the section header doc convention more clearly optional | ||
|---|---|---|---|
| Type: | enhancement | Stage: | resolved |
| Components: | Devguide | Versions: |
process
| Status: | closed | Resolution: | fixed |
|---|---|---|---|
| Dependencies: | Superseder: | ||
| Assigned To: | Nosy List: | chris.jerdonek, eric.araujo, ezio.melotti, ncoghlan, python-dev | |
| Priority: | normal | Keywords: | easy, patch |
Created on 2013-02-22 02:18 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.
| Files | |||
|---|---|---|---|
| File name | Uploaded | Description | Edit |
| devguide-section-headers.diff | chris.jerdonek,2013-02-22 02:18 |
| Messages (3) | ||
|---|---|---|
| msg182620 - (view) | Author: Chris Jerdonek (chris.jerdonek) *  |
Date: 2013-02-22 02:18 |
| The documentation guidelines in the devguide list a convention for section headers: http://docs.python.org/devguide/documenting.html#sections The current wording, however, can be interpreted to mean that this convention is always (and should always) be used. However, the reality is weaker. For example, see: http://bugs.python.org/issue17109#msg181302 This issue is to update the wording so the convention is more clearly a suggestion rather than a requirement. | ||
| msg182621 - (view) | Author: Ezio Melotti (ezio.melotti) * |
Date: 2013-02-22 02:19 |
| LGTM | ||
| msg182623 - (view) | Author: Roundup Robot (python-dev)  |
Date: 2013-02-22 02:25 |
| New changeset fa06f733e2fe by Chris Jerdonek in branch 'default': Issue #17270: clarify that the section header doc convention is optional. http://hg.python.org/devguide/rev/fa06f733e2fe |
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:57:42 | admin | set | github: 61472 |
| 2013-02-22 02:27:01 | chris.jerdonek | set | status: open -> closedresolution: fixedstage: commit review -> resolved |
| 2013-02-22 02:25:27 | python-dev | set | nosy: + python-devmessages: + |
| 2013-02-22 02:19:11 | ezio.melotti | set | messages: + stage: patch review -> commit review |
| 2013-02-22 02🔞03 | chris.jerdonek | create |
Supported by The Python Software Foundation,
Powered by Roundup
Copyright © 1990-2022, Python Software Foundation
Legal Statements