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

tapify input description manually #138

Closed
kddubey opened this issue Jun 15, 2024 · 1 comment · Fixed by #139
Closed

tapify input description manually #138

kddubey opened this issue Jun 15, 2024 · 1 comment · Fixed by #139

Comments

@kddubey
Copy link
Contributor

kddubey commented Jun 15, 2024

Currently, tapify always gets the script description for -h from the docstring of the input.

When the input is a class, its docstring usually doesn't tell you what the script is going to do. The class usually represents data that's inputted to a function/method.

The user should be able to pass in a description manually through a new kwarg in tapify, description, which defaults to the current behavior: get the description from the input's docstring.

I'll submit a PR for this in a few days or weeks in case no else gets to it

@martinjm97
Copy link
Collaborator

I agree it would be helpful to add the ability to manually provide a description that overrides the docstring. A PR would be greatly appreciated!

--Jesse

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

Successfully merging a pull request may close this issue.

2 participants