added note about laziness of operations to statistical functions #3293
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
|
@valeriupredoi @ledm How's this format for you? |
|
Good one, thanks! |
|
music to my ears 😁 cheers @corinnebosley 🍺 |
lbdreyer
reviewed
Mar 13, 2019
| @@ -31,6 +31,8 @@ | |||
| def _ones_like(cube): | |||
| """ | |||
| Return a copy of cube with the same mask, but all data values set to 1. | |||
|
|
|||
| The operation is non-lazy. | |||
There was a problem hiding this comment.
I may be missing some context here as to the purpose of this PR, but this line doesn't seem necessary to add.
I'm assuming your intention is to clarify which functions are lazy for the user. If that is the case, it is surely not necessary to add this to a private function, which won't be included in the documentation?
There was a problem hiding this comment.
I guess this note would be useful for the next developer who looks at the code, wanting to make the public function lazy?
|
@corinnebosley Thanks. |
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.
Only two functions to clarify here. This is a small one to start us off.