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

fix documentation #3

Open
fgrunewald opened this issue Apr 5, 2020 · 1 comment
Open

fix documentation #3

fgrunewald opened this issue Apr 5, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@fgrunewald
Copy link
Member

Docstrings need to either be added or put into proper format
@fgrunewald fgrunewald added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 5, 2020
@fgrunewald
Copy link
Member Author

If you want to typehint this completely (optional), you can do something like templates: dict[str, vermouth.molecule.Block], indicating its keys are strings and values are Blocks. You'll still need to tell the str is a resname.
And I'm not sure how much sphinx/autodoc/apidoc likes the not-4-spaces indent. But that we can fix later

Originally posted by @pckroon in #29

@fgrunewald fgrunewald mentioned this issue Oct 14, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fgrunewald