Skip to content

added note about laziness of operations to statistical functions#3293

Merged
bjlittle merged 2 commits into
SciTools:masterfrom
corinnebosley:clarify_laziness_of_stats
Jul 10, 2019
Merged

added note about laziness of operations to statistical functions#3293
bjlittle merged 2 commits into
SciTools:masterfrom
corinnebosley:clarify_laziness_of_stats

Conversation

@corinnebosley

Copy link
Copy Markdown
Member

Only two functions to clarify here. This is a small one to start us off.

@corinnebosley

Copy link
Copy Markdown
Member Author

@valeriupredoi @ledm How's this format for you?

@ledm

ledm commented Mar 6, 2019

Copy link
Copy Markdown

Good one, thanks!

@corinnebosley

Copy link
Copy Markdown
Member Author

@pp-mo @bjlittle @lbdreyer I've got a whole load of these PRs coming up, if somebody could spare the time to check them over as they come up I'd be really grateful.

@valeriupredoi

Copy link
Copy Markdown
Contributor

music to my ears 😁 cheers @corinnebosley 🍺

"""
Return a copy of cube with the same mask, but all data values set to 1.

The operation is non-lazy.

@lbdreyer lbdreyer Mar 13, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this note would be useful for the next developer who looks at the code, wanting to make the public function lazy?

@bjlittle

Copy link
Copy Markdown
Member

@corinnebosley Thanks.

@bjlittle bjlittle merged commit 4520590 into SciTools:master Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants