Numpy docstrings #65
Merged
Numpy docstrings #65
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
|
fix #60 |
Sosnowsky
approved these changes
Jun 15, 2023
blobmodel/blobs.py
Outdated
| blob_alignment : bool, optional | ||
| If blob_aligment == True, the blob shapes are rotated in the propagation direction of the blob | ||
| If blob_aligment == False, the blob shapes are independent of the propagation direction | ||
| theta : float |
There was a problem hiding this comment.
Should this be documented? It is not an input parameter, maybe it should be private
In either case, if documented, it should be "Angle of the blob's velocity vector with the x-axis if blob_aligment=True, else 0"
There was a problem hiding this comment.
Thanks, I removed theta from the docstring.
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 adds numpy style docstrings to the code. This is a first step for building a usable documentation for the package. As a next step I intend to implement a propper docs page using sphinx.
Some of docstrings seem like extra boiler plate code but I added them anyway for automatic doc generating with sphinx.