Skip to content

Conversation

@thinkingfish
Copy link
Member

No description provided.


#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))]
pub struct SparseHistogramRO {
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's add a doc comment for the struct. It'd be nice to have something that explains what it is and when you might use it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if calling it an CumulativeSparseHistogram is clearer. I'm not sure I love the short suffix to indicate read-only. ImmutableSparseHistogram might be better if you want to keep the focus on that aspect instead of how it's implemented.

Copy link
Member Author

Choose a reason for hiding this comment

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

I like CumulativeSparseHistogram, we can explain why it only supports the read methods in the doc comment.

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.

2 participants