Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manpage typos #312

Open
defjaf opened this issue Aug 16, 2023 · 3 comments
Open

Manpage typos #312

defjaf opened this issue Aug 16, 2023 · 3 comments
Labels
impact-docs Changes the documentation

Comments

@defjaf
Copy link

defjaf commented Aug 16, 2023

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
@defjaf defjaf changed the title manpage typos Manpage typos Aug 16, 2023
@brettcannon brettcannon added the impact-docs Changes the documentation label Aug 16, 2023
@brettcannon
Copy link
Owner

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].

@brettcannon
Copy link
Owner

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

@brettcannon
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact-docs Changes the documentation
Projects
None yet
Development

No branches or pull requests

2 participants