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

Help text injected by CustomHelpFormatter is not included in rendered docs #1706

Open
Tracked by #1642
victorlin opened this issue Jan 7, 2025 · 0 comments
Open
Tracked by #1642
Labels
documentation Improvements or additions to documentation

Comments

@victorlin
Copy link
Member

victorlin commented Jan 7, 2025

from #1705 (review)

#1705 appends text to the end of certain arguments in the --help output. However, these are not shown in the rendered docs.

Example for augur curate format-dates:

  --metadata-delimiters METADATA_DELIMITERS [METADATA_DELIMITERS ...]
                        Delimiters to accept when reading a plain text metadata file. Only
                        one delimiter will be inferred. Specified values will override the
                        default list. (default: (',', '\t'))

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant