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 default values to print_valid_kwargs() #69

Open
rmatsum836 opened this issue Jun 1, 2020 · 1 comment
Open

Add default values to print_valid_kwargs() #69

rmatsum836 opened this issue Jun 1, 2020 · 1 comment
Milestone

Comments

@rmatsum836
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
I was just looking through inp_functions.py to find the default values for several kwargs, and I think it would be nice to add these to the doctoring that is printed from print_valid_kwargs().

Describe the solution you'd like
For kwargs that have default values, such as coord_freq, add the default values to the doc string for print_valid_kwargs().

Describe alternatives you've considered
Maybe this is information is already present somewhere else that I'm missing.

@rsdefever
Copy link
Collaborator

They are here: https://mosdef-cassandra.readthedocs.io/en/latest/guides/kwargs.html

But I am not opposed to adding them to print_valid_kwargs as well.

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

2 participants