doc: improve docstrings formatting - #759
Conversation
Conflicts: doc/release_notes.md
| Namespace containing spatial information for different carriers, | ||
| including nodes and locations | ||
| including nodes and locations. | ||
| options : dict |
There was a problem hiding this comment.
Are the options optional here like for tech cost assumptions? Some functions have "options : dict" whilst others have options : dict, optional (and then some lines on defaulting if the string is empty such as l4138 of prepare_sector_network.py). If so, small inconsistency with options in Parameters of fucntions.
There was a problem hiding this comment.
The full stop is missing in theory, but this is the case for all the def add_generation() function, where none have full stops. Not sure if to fix this.
There was a problem hiding this comment.
Are the options optional here like for tech cost assumptions?
It seems that we have been slightly inconsistent wrt to options. Some functions define the attribute as optional, other do not. Out of scope for this PR. The docstrings are consistent with the function attributes.
There was a problem hiding this comment.
The full stop is missing in theory, but this is the case for all the def add_generation() function, where none have full stops. Not sure if to fix this.
I can't see any missing characters. The attribute types don't have a final full stop, but their definitions do.
There was a problem hiding this comment.
I agree with the out of scope call. Do we need a follow-up issue for the options?
|
I can make the changes sometime this week if needed! @tgilon |
69a59b3 to
05f0fe9
Compare
Conflicts: envs/default_linux-64.pin.txt envs/default_osx-64.pin.txt envs/default_osx-arm64.pin.txt envs/default_win-64.pin.txt pixi.lock
|
@lisazeyen @daniel-rdt Could one of you two review this, as Andreas is unavailable? |
3 participants
Closes # (if applicable).
Changes proposed in this Pull Request
Follow up of #754. This PR improves the docstrings formatting following the approach introduced by PyPSA#2162. This PR also adds missing type hints.
Tasks
Workflow
Open issues
Notes
Generative AI was used to assist with code generation and review. All content has been reviewed, verified, and is the responsibility of the author.
Checklist
pixi.toml(usingpixi add <dependency-name>).config/config.default.yaml.doc/configtables/*.csv.config/test/*.yaml.pixi run -e open-tyndp tyndp-cyears-test).doc/*.rstfiles.doc/release_notes.rstis added.doc/index.rst.