Documentation: rest of the dostrings heatpump rest #57
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
…cumentation/DStrings_Heatpump-Rest
jgrguric96
commented
Oct 23, 2024
| @@ -274,7 +274,7 @@ def get_data(self, outputs:dict) -> dict: # to be implemented | |||
| 'time': output_time (for event-based sims, optional) | |||
| } | |||
|
|
|||
| See Also | |||
| See Alsoe | |||
There was a problem hiding this comment.
Will fix these once all the PRs are merged.
manuGil
approved these changes
Oct 24, 2024
| If two numbers are equally close, return the smallest number. | ||
| [Josip] Since this is just fetching an item from a sorted list, this could be replaced with a binary search algorithm |
There was a problem hiding this comment.
It will be best to document comment/suggestions like this as issues in the repo and add a link to the code lines. That will make this more visible and likely to be picked up and fixed.
Comment on lines
+1012
to
+1018
| Returns the minimum of the `self.P_th_stages` attribute | ||
|
|
||
| Returns | ||
| ------- | ||
| self.P_th_stages : ??? | ||
| ??? | ||
| """ |
There was a problem hiding this comment.
We should recommend that missing details like in this case should be fixed when the models are translated to the new interface.
| @@ -397,27 +490,65 @@ def get_nested_attr(self, nested_attr): | |||
| return getattr(if_type[name], attr) | |||
There was a problem hiding this comment.
For future reference. Exceptions are usually documented in doc strings under the heading Raises, with the format <errorType>: <description of the error/exception>.
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.
The rest of the models' documentation