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

[FEAT/script]: Document all scripts #22

Open
andthum opened this issue Jul 7, 2021 · 0 comments
Open

[FEAT/script]: Document all scripts #22

andthum opened this issue Jul 7, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@andthum
Copy link
Owner

andthum commented Jul 7, 2021

Is your feature request related to a problem? Please describe.
Currently, only six scripts are documented in the official documentation (scripts/discretization/discrete_pos.py, scripts/structure/contact_hist.py, scripts/structure/lig_change_at_pos_change_blocks.py, scripts/structure/lig_change_at_pos_change_blocks_hist.py and the two script templates scripts/script_template.py and scripts/script_template_dtrj.py. The only way you can get help about the other scripts is the -h option (or asking the author).

Describe the solution you'd like
Add docstrings to all scripts and include them in the documentation.
@andthum andthum added the enhancement New feature or request label Jul 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andthum