Extend docstrings #613
Merged
Extend docstrings #613
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d_docstrings # Conflicts: # mala/common/parameters.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to close #587. Some have already been taken care of in #609, but generally there are quite some functions missing docstrings. Especially I initially forgot to add "Attributes" docstrings to many classes. In looking through this I realized how many classes have "public" (I know, I know, python's concept of privacy are a bit dubious) members for things only used internally, which I think can be avoided. This PR also addresses this; the idea is that every variable publicly available is documented, and everything else is private (either the "polite" private with a single underscore or the actually enforces private with two underscores which does not get inherited). I will not alter the doc strings already touched by #609.