[issue15569] Doc doc: incorrect description of some roles as format-only
Georg Brandl added the comment: Thanks! -- nosy: +georg.brandl resolution: fixed - stage: resolved - needs patch status: closed - open ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Roundup Robot added the comment: New changeset bef3ddfe5d09 by Georg Brandl in branch 'default': Closes #15569: some roles do create more than formatting https://hg.python.org/devguide/rev/bef3ddfe5d09 -- nosy: +python-dev resolution: - fixed stage: needs patch - resolved status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Changes by Georg Brandl ge...@python.org: -- resolution: - fixed status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Changes by Berker Peksag berker.pek...@gmail.com: -- stage: needs patch - resolved ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Emily Zhao added the comment: I moved the 3 misplaced roles (envvar, keyword, and option) and changed the description for the new section per Terry's suggestions. Patch is attached and needs to go in the devguide repo. https://docs.python.org/devguide/docquality.html#helping-with-the-developers-guide -- keywords: +patch nosy: +emily.zhao Added file: http://bugs.python.org/file35517/issue15569.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Terry J. Reedy added the comment: There are no versions for the devguide. There is another misplaced role: : option A command-line option of Python. The leading hyphen(s) must be included. If a matching cmdoption directive exists, it is linked to. For options of other programs or scripts, use simple ``code`` markup. I think The following role does possibly create a cross-reference, but does not refer to objects: should be changed to something like The following roles do not refer to module objects, but possibly create cross-references or internal links:. Move the three misplaced roles here, along with token and term. -- nosy: +terry.reedy versions: -Python 2.7, Python 3.2, Python 3.3, Python 3.4 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Changes by Ezio Melotti ezio.melo...@gmail.com: -- type: - enhancement versions: +Python 2.7, Python 3.2, Python 3.3, Python 3.4 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Changes by Mike Hoy mho...@gmail.com: -- nosy: -mikehoy ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Mike Hoy added the comment: I would like to submit a patch for this. Is anyone currently working on one? -- nosy: +mikehoy ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue15569] Doc doc: incorrect description of some roles as format-only
Changes by Éric Araujo mer...@netwok.org: -- assignee: - docs@python nosy: +docs@python, eric.araujo stage: - needs patch title: Dev Guide format-only roles - Doc doc: incorrect description of some roles as format-only ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue15569 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
