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.

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

Minor issues with Enum docs #63347

Closed
EsaPeuha mannequin opened this issue Oct 2, 2013 · 4 comments
Closed

Minor issues with Enum docs #63347

EsaPeuha mannequin opened this issue Oct 2, 2013 · 4 comments
Assignees
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@EsaPeuha
Copy link
Mannequin

EsaPeuha mannequin commented Oct 2, 2013

BPO 19148
Nosy @birkenfeld, @ezio-melotti, @ethanfurman
Files
  • enum.diff: fix markup in enum.rst
  • 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 = 'https://github.com/ezio-melotti'
    closed_at = <Date 2013-10-05.01:16:10.524>
    created_at = <Date 2013-10-02.20:29:21.762>
    labels = ['type-feature', 'docs']
    title = 'Minor issues with Enum docs'
    updated_at = <Date 2013-10-05.01:16:10.522>
    user = 'https://bugs.python.org/EsaPeuha'

    bugs.python.org fields:

    activity = <Date 2013-10-05.01:16:10.522>
    actor = 'ezio.melotti'
    assignee = 'ezio.melotti'
    closed = True
    closed_date = <Date 2013-10-05.01:16:10.524>
    closer = 'ezio.melotti'
    components = ['Documentation']
    creation = <Date 2013-10-02.20:29:21.762>
    creator = 'Esa.Peuha'
    dependencies = []
    files = ['31947']
    hgrepos = []
    issue_num = 19148
    keywords = ['patch']
    message_count = 4.0
    messages = ['198869', '198884', '198975', '198976']
    nosy_count = 6.0
    nosy_names = ['georg.brandl', 'ezio.melotti', 'docs@python', 'ethan.furman', 'python-dev', 'Esa.Peuha']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue19148'
    versions = ['Python 3.4']

    @EsaPeuha
    Copy link
    Mannequin Author

    EsaPeuha mannequin commented Oct 2, 2013

    I noticed a couple of issues with the Enum documentation. First, there are some markup bugs which should be fixed by the attached file. Second, I think "If the only change desired is no aliases allowed" is very bad English and should be reworded; I would go with "If you only want to disallow aliases" but maybe other people have better ideas.

    @EsaPeuha EsaPeuha mannequin assigned docspython Oct 2, 2013
    @EsaPeuha EsaPeuha mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 2, 2013
    @birkenfeld
    Copy link
    Member

    Patch LGTM.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Oct 5, 2013

    New changeset db94fc7218fa by Ezio Melotti in branch 'default':
    bpo-19148: fix markup errors and wording in enum docs. Patch by Esa Peuha.
    http://hg.python.org/cpython/rev/db94fc7218fa

    @ezio-melotti
    Copy link
    Member

    Fixed, thanks for the report and the patch!
    I used a slightly different wording than the one you suggested because the rest of the document doesn't seem to use "you".

    @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
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants