Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make the section header doc convention more clearly optional #61472

Closed
cjerdonek opened this issue Feb 22, 2013 · 3 comments
Closed

make the section header doc convention more clearly optional #61472

cjerdonek opened this issue Feb 22, 2013 · 3 comments
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@cjerdonek
Copy link
Member

BPO 17270
Nosy @ncoghlan, @ezio-melotti, @merwok, @cjerdonek
Files
  • devguide-section-headers.diff
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2013-02-22.02:27:01.194>
created_at = <Date 2013-02-22.02:18:03.390>
labels = ['easy', 'type-feature', 'docs']
title = 'make the section header doc convention more clearly optional'
updated_at = <Date 2013-02-22.02:27:01.193>
user = 'https://github.com/cjerdonek'

    bugs.python.org fields:

    activity = <Date 2013-02-22.02:27:01.193>
actor = 'chris.jerdonek'
assignee = 'none'
closed = True
closed_date = <Date 2013-02-22.02:27:01.194>
closer = 'chris.jerdonek'
components = ['Devguide']
creation = <Date 2013-02-22.02:18:03.390>
creator = 'chris.jerdonek'
dependencies = []
files = ['29153']
hgrepos = []
issue_num = 17270
keywords = ['patch', 'easy']
message_count = 3.0
messages = ['182620', '182621', '182623']
nosy_count = 5.0
nosy_names = ['ncoghlan', 'ezio.melotti', 'eric.araujo', 'chris.jerdonek', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17270'
versions = []
    @cjerdonek
    Copy link
    Member Author

    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.

    @cjerdonek cjerdonek added docs Documentation in the Doc dir easy type-feature A feature request or enhancement labels Feb 22, 2013
    @ezio-melotti
    Copy link
    Member

    LGTM

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Feb 22, 2013

    New changeset fa06f733e2fe by Chris Jerdonek in branch 'default':
    Issue bpo-17270: clarify that the section header doc convention is optional.
    http://hg.python.org/devguide/rev/fa06f733e2fe

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @cjerdonek @ezio-melotti