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.

Sign up for GitHub

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

Jump to bottom

%(default) not supported in help message #27

Closed
fallen opened this issue Mar 24, 2015 · 2 comments
Closed

%(default) not supported in help message #27

fallen opened this issue Mar 24, 2015 · 2 comments

Comments

@fallen
Copy link

fallen commented Mar 24, 2015

It seems sphinx-argparse does not support expanding the %(default) contained in help string of the add_argument().
sphinx-argparse will literaly print "%(default)" instead of replacing it with the default argument of the add_argument().

Please, see https://docs.python.org/3/library/argparse.html#help

Thanks!
asmeurer added a commit to drdoctr/doctr that referenced this issue Aug 9, 2016
@asmeurer
Command line documentation using sphinxarg
e7888e3 
We won't actually use this, because it doesn't replace %(default)s in the help
strings (alex-rudakov/sphinx-argparse#27).
@tgarc
Copy link

tgarc commented Aug 25, 2016

Yes this is also an issue for me as I always include the %(default) variable in help strings.

dpryan79 added a commit that referenced this issue Oct 6, 2016
@dpryan79
Fix #27; fill in things like %(default)s and %(prog)s in help text
7fb1875
@dpryan79
Copy link
Collaborator

dpryan79 commented Oct 6, 2016

I've now implemented this in the develop branch. Please give it a try and let me know if it has trouble with any of your use cases.

@dpryan79 dpryan79 closed this as completed Oct 6, 2016
@schlepuetz schlepuetz mentioned this issue Aug 26, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fallen @tgarc @dpryan79