Improve docstrings #267
Merged
Improve docstrings #267
Conversation
This file contains hidden or 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
ondras12345
force-pushed
the
improve-docstrings
branch
from
6feceb2 to
b183a5f
Compare
It does not work, and its name is inconsistent with the rest of the API (note the lowercase l). I can't even tell what it was supposed to do. This closes OpenModelica#248
ondras12345
force-pushed
the
improve-docstrings
branch
from
b183a5f to
2cce81a
Compare
adeas31
approved these changes
Apr 28, 2025
Member
adeas31
left a comment
adeas31
left a comment
There was a problem hiding this comment.
Currently I don't have time to do this for all methods.
Also, I have encountered some questions that should be answered before docstrings for the other methods are written: #260.
Lets just push this in for now. We can improve the docstrings of other methods later on.
Contributor
|
@adeas31 any prefered docstyle to use? @ondras12345 which docstring style did you use - it is not my default one (Numpy) ;-) |
Contributor
Author
|
Google-style docstrings, as stated in the description of this PR. However, I don't feel strongly about it. You can change it to numpy-style if you think it's better. |
Contributor
|
@ondras12345 sorry, this was so clear at the top that I missed it; I will have to check this style as I'm not familiar with it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 tries to improve the docstrings of some of ModelicaSystem's methods.
The new docstrings follow the Google Style Docstring format (I hope).
Currently I don't have time to do this for all methods.
Also, I have encountered some questions that should be answered before docstrings for the other methods are written: #260.