[issue36083] Misformated manpage: --check-hash-based-pycs ´default´|´always´|´never´
New submission from Miro Hrončok <miro@hroncok.cz>: man python3.7 or man python3.8 says this in synopsis: python [ -B ] [ -b ] [ -d ] [ -E ] [ -h ] [ -i ] [ -I ] [ -m module-name ] [ -q ] [ -O ] [ -OO ] [ -s ] [ -S ] [ -u ] [ -v ] [ -V ] [ -W argument ] [ -x ] [ [ -X option ] -? ] [ --check-hash-based-pycs ´default´|´always´|´never´ ] [ -c command | script | - ] [ arguments ] Some words are bold, some are underlined. However the ´default´|´always´|´never´ bit after --check-hash-based-pycs is misformated. The backticks should not be there, they should be underline instead. The source literally has: [ .B \--check-hash-based-pycs \'default\'|\'always\'|\'never\' ] since the original implementation of PEP 552 in 42aa93b8ff2f7879282b06efc73a31ec7785e602 I think it should be replaced with: [ .B \--check-hash-based-pycs .I default|always|never ] Shall I send a PR? ---------- assignee: docs@python components: Documentation messages: 336342 nosy: docs@python, hroncok priority: normal severity: normal status: open title: Misformated manpage: --check-hash-based-pycs ´default´|´always´|´never´ versions: Python 3.7, Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: Thanks for the report, Miro! Adding Benjamin Peterson to the nosy, since that was his commit. I'd wait until he comments before making a PR. ---------- nosy: +benjamin.peterson, cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
Benjamin Peterson <benjamin@python.org> added the comment: A PR would be welcome. On Sat, Feb 23, 2019, at 12:08, Cheryl Sabella wrote:
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment:
Thanks for the report, Miro! Adding Benjamin Peterson to the nosy, since that was his commit. I'd wait until he comments before making a PR.
---------- nosy: +benjamin.peterson, cheryl.sabella
_______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
Change by Miro Hrončok <miro@hroncok.cz>: ---------- keywords: +patch pull_requests: +12048 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
Benjamin Peterson <benjamin@python.org> added the comment: New changeset 16323cb2c3d315e02637cebebdc5ff46be32ecdf by Benjamin Peterson (Miro Hrončok) in branch 'master': closes bpo-36083: Fix formatting of the manpage Synopsis. (GH-12017) https://github.com/python/cpython/commit/16323cb2c3d315e02637cebebdc5ff46be3... ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +12058 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset ca5e6aaea5168bff274f3e98d7970bfa1bc366a2 by Miss Islington (bot) in branch '3.7': closes bpo-36083: Fix formatting of the manpage Synopsis. (GH-12017) https://github.com/python/cpython/commit/ca5e6aaea5168bff274f3e98d7970bfa1bc... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36083> _______________________________________
participants (4)
-
Benjamin Peterson
-
Cheryl Sabella
-
Miro Hrončok
-
miss-islington