brettcannon / python-launcher

Python launcher for Unix

Home Page:https://python-launcher.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Manpage typos

defjaf opened this issue · comments

Describe the bug
man py incorrectly shows -list and -help options (i.e., with a single "-")

(Also, possibly a separate issue, the "synopsis" should probably show the help and list options.)

To Reproduce
$ man py

...
SYNOPSIS
       py [-[X]/[X.Y]] ...
...
OPTIONS
       -h/–help
              Print a help message and exit; must be specified on its own.

       –list  List all known interpreters (except activated virtual environment); must be specified on its own.

Expected behaviour
Above should show --list and --help.

System Details (please complete the following information):

  • OS: macOS 13.5 with homebrew python 3.11
  • Shell: bash
  • Launcher Version: 1.0.0

It's actually written down correctly in the Markdown file, e.g.:

**-h**/**--help**

Unfortunately, pandoc is not translating it appropriately:

.B \f[B]\-h\f[]/\f[B]\[en]help\f[]

It might require some escaping in the Markdown or some flag to pandoc to not translate -- to \[en].

https://pandoc.org/demo/pandoc.1.md is how pandoc uses Markdown for its man page; looks like an escape for the first dash is what's necessary, e.g., \--help.

It also seems the more common style is a comma separating the options (at least comparing pandoc and curl's man pages), e.g., -h, \--help

https://pandoc.org/try/?text=&from=markdown&to=man is useful for trying to figure out what pandoc will do.