Added Docstrings to base.py #35
Open
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
Open
MrJulEnergy
requested changes
Feb 25, 2023
znflow/base.py
Outdated
Comment on lines
115
to
117
| """ | ||
|
|
||
| """ |
There was a problem hiding this comment.
Please provide proper docstring, or remove entirely
MrJulEnergy
approved these changes
Feb 27, 2023
PythonFZ
reviewed
Mar 1, 2023
znflow/base.py
Outdated
Comment on lines
52
to
54
| """A method that checks for an existing UUID. | ||
|
|
||
| If no UUID exists, it sets the previously defined UUID for the node. |
PythonFZ
reviewed
Mar 1, 2023
| if self._uuid is not None: | ||
| raise ValueError("uuid is already set") | ||
| self._uuid = value | ||
|
|
||
| def run(self): | ||
| """Run Method of NodeBaseMixin.""" |
There was a problem hiding this comment.
The run method is a really important abstract method. It's the method that is executed upon the graph run call.
PythonFZ
reviewed
Mar 1, 2023
znflow/base.py
Outdated
Comment on lines
91
to
92
| attribute: | ||
| Node.attribute |
There was a problem hiding this comment.
I know, this is on me, but could you change this to numpy docstrings format?
# Conflicts: # znflow/base.py # znflow/graph.py
PythonFZ
reviewed
Mar 20, 2023
# Conflicts: # znflow/base.py
# Conflicts: # znflow/base.py
…into 2-add-docstrings # Conflicts: # znflow/base.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.
No description provided.