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

Add option to prevent comment from being used as argument explanations #352

Open
yuanchen-zhu opened this issue Mar 28, 2025 · 0 comments
Open

Comments

@yuanchen-zhu
Copy link

yuanchen-zhu commented Mar 28, 2025

I find this library extremely useful. Thank you for your great work!

Is your feature request related to a problem? Please describe.
It would be nice to have an option to indicate only docstrings are used for argument explanations. I often have nonformal comments describing TODOs and intentions that should not be visible to the external user. Right now to stop it from showing up in the argument explanation, I need to explicitly add a docstring under it.

Describe the solution you'd like

Add an option in ArgumentParser that prevent comment from being used as argument explanation.

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

No branches or pull requests

1 participant