Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor updates #3

Merged
merged 2 commits into from
Dec 2, 2020
Merged

docs: minor updates #3

merged 2 commits into from
Dec 2, 2020

Conversation

henryiii
Copy link
Member

@henryiii henryiii commented Dec 2, 2020

This is a followup to #2, with one more possible change. This is a bit of extra typing, but is much clearer; I could see the following to be rather confusing if this is named counts instead of effective_counts, since it's not always the true number of counts, but an effective count calculation. For a user filling a weighed sum or weighed mean histogram, the fact that ".counts" is neither the number of times filled nor the weighted number of times filled is likely to be quite a surprise. While if it was called "effective_counts", they would be more likely to suspect that it's a special computed quantity and not just the raw or weighted counts.

Followup to #2, CC @HDembinski and @jpivarski.

@jpivarski
Copy link
Member

I'm going to bring Uproot in line with histogram updates today. Can I take

https://github.com/henryiii/uhi/blob/343fae1a7aa4e88e8a2d64016d897b58c6e2d260/uhi/typing/plottable.py

to be the standard to adhere to? (It's the version of plottable.py in this PR, after the only commit: 343fae1.

jpivarski added a commit to scikit-hep/uproot5 that referenced this pull request Dec 2, 2020
@henryiii
Copy link
Member Author

henryiii commented Dec 2, 2020

Just waiting on a sign-off from @HDembinski so we are all in accord. We changed the meaning of "counts" to be effective counts" without changing the name, so I think the new name is likely fine.

jpivarski added a commit to scikit-hep/uproot5 that referenced this pull request Dec 2, 2020
uhi/typing/plottable.py Outdated Show resolved Hide resolved
@henryiii henryiii changed the title feat: counts -> effective_counts docs: minor updates Dec 2, 2020
@henryiii henryiii merged commit 02f5aa0 into master Dec 2, 2020
@henryiii henryiii deleted the henryiii-patch-1 branch December 2, 2020 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants