[New-bugs-announce] [issue36083] Misformated manpage: --check-hash-based-pycs ´default´|´always´|´never´

[Miro Hrončok]

New submission from Miro Hrončok <miro at 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 at python
components: Documentation
messages: 336342
nosy: docs at 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 at bugs.python.org>
<https://bugs.python.org/issue36083>
_______________________________________