[issue23322] parser module docs missing second example
New submission from Devin Jeanpierre: 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 ---------- assignee: docs@python components: Documentation messages: 234716 nosy: Devin Jeanpierre, docs@python priority: normal severity: normal status: open title: parser module docs missing second example versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Berker Peksag added the comment: 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. ---------- keywords: +easy nosy: +berker.peksag stage: -> needs patch versions: -Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Vipul Sharma added the comment: Can I work on this ? This would be my first contribution here also it looks good for a beginner ---------- nosy: +Vipul.Sharma _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Berker Peksag added the comment: Welcome, please go ahead and send a patch. Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Vipul Sharma added the comment: 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" ? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Sahil Chelaramani added the comment: A patch for this bug. Please let me know if I have to change something. First patch, please be kind :) ---------- keywords: +patch nosy: +SahilC Added file: http://bugs.python.org/file38196/mywork.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Roundup Robot added the comment: New changeset b479e74f7706 by Berker Peksag in branch '3.5': Issue #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 #23322: Merge from 3.5 https://hg.python.org/cpython/rev/099fd7954941 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
Berker Peksag added the comment: Thanks, Sahil. ---------- resolution: -> fixed stage: needs patch -> resolved status: open -> closed type: -> behavior versions: +Python 3.6 -Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________
participants (5)
-
Berker Peksag
-
Devin Jeanpierre
-
Roundup Robot
-
Sahil Chelaramani
-
Vipul Sharma