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

parser module docs missing second example #67511

Closed
ssbr mannequin opened this issue Jan 26, 2015 · 8 comments
Closed

parser module docs missing second example #67511

ssbr mannequin opened this issue Jan 26, 2015 · 8 comments
Labels
docs Documentation in the Doc dir easy type-bug An unexpected behavior, bug, or error

Comments

@ssbr
Copy link
Mannequin

ssbr mannequin commented Jan 26, 2015

BPO 23322
Nosy @ssbr, @berkerpeksag
Files
  • mywork.patch: Updated seealso section to include link.
  • 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 2016-08-08.10:06:50.856>
    created_at = <Date 2015-01-26.07:31:16.957>
    labels = ['easy', 'type-bug', 'docs']
    title = 'parser module docs missing second example'
    updated_at = <Date 2016-08-08.10:06:50.854>
    user = 'https://github.com/ssbr'

    bugs.python.org fields:

    activity = <Date 2016-08-08.10:06:50.854>
    actor = 'berker.peksag'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2016-08-08.10:06:50.856>
    closer = 'berker.peksag'
    components = ['Documentation']
    creation = <Date 2015-01-26.07:31:16.957>
    creator = 'Devin Jeanpierre'
    dependencies = []
    files = ['38196']
    hgrepos = []
    issue_num = 23322
    keywords = ['patch', 'easy']
    message_count = 8.0
    messages = ['234716', '234717', '234805', '234806', '234818', '236368', '272157', '272158']
    nosy_count = 6.0
    nosy_names = ['Devin Jeanpierre', 'docs@python', 'python-dev', 'berker.peksag', 'SahilC', 'Vipul.Sharma']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue23322'
    versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

    @ssbr
    Copy link
    Mannequin Author

    ssbr mannequin commented Jan 26, 2015

    The port to reST missed the second example: https://docs.python.org/release/2.5/lib/node867.html

    This is still referred to in the docs, so it is not deliberate. For example, the token module docs say "The second example for the parser module shows how to use the symbol module": https://docs.python.org/3.5/library/token.html#module-token

    There is no second example, nor any use of the symbol module, in the docs: https://docs.python.org/3.5/library/parser.html

    @ssbr ssbr mannequin assigned docspython Jan 26, 2015
    @ssbr ssbr mannequin added the docs Documentation in the Doc dir label Jan 26, 2015
    @berkerpeksag
    Copy link
    Member

    The second example was removed in https://hg.python.org/cpython/rev/19ca70b463c5 It would be better to just update the "see also" note in the token documentation.

    @VipulSharma
    Copy link
    Mannequin

    VipulSharma mannequin commented Jan 27, 2015

    Can I work on this ? This would be my first contribution here also it looks good for a beginner

    @berkerpeksag
    Copy link
    Member

    Welcome, please go ahead and send a patch. Thanks!

    @VipulSharma
    Copy link
    Mannequin

    VipulSharma mannequin commented Jan 27, 2015

    Should I just remove the "See also" segment or just update its content like "See also: module parser.. Provides an interface to Python’s internal parser and byte-code compiler" ?

    @SahilC
    Copy link
    Mannequin

    SahilC mannequin commented Feb 21, 2015

    A patch for this bug. Please let me know if I have to change something. First patch, please be kind :)

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Aug 8, 2016

    New changeset b479e74f7706 by Berker Peksag in branch '3.5':
    Issue bpo-23322: Remove outdated reference to an example in parser docs
    https://hg.python.org/cpython/rev/b479e74f7706

    New changeset 099fd7954941 by Berker Peksag in branch 'default':
    Issue bpo-23322: Merge from 3.5
    https://hg.python.org/cpython/rev/099fd7954941

    @berkerpeksag
    Copy link
    Member

    Thanks, Sahil.

    @berkerpeksag berkerpeksag added the type-bug An unexpected behavior, bug, or error label Aug 8, 2016
    @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 easy type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant