Error enums #22
Error enums #22
Conversation
|
This is on top of #16. |
src/lib.rs
Outdated
| /// Number of significant digits must be between 0 and 5 | ||
| SigFigTooBig, | ||
| /// Cannot represent sigfig worth of values beyond low | ||
| CannotRepresentSigFigBeyondLow |
There was a problem hiding this comment.
I expect most people will probably not match each of these variants but at least it will be nicely specific if their usage panics.
There was a problem hiding this comment.
Yup. I think we might be able to bikeshed some better names for the variants, but it's probably not worth the time.
I do think we should give some better documentation for the variants though. This will be one of the main places where people will look for an explanation of why something didn't work, so we should make sure things are as clear as possible. For example, why can't SigFig be bigger than 5, why must high be at least twice of low, etc. For some of these we have explanations elsewhere in the code, and I think those can be moved here.
Also, a minor point, but you should enclose code things (like u64::max_value() / 2) in backticks.
| pub enum AdditionError { | ||
| /// The other histogram includes values that do not fit in this histogram's range. | ||
| /// Only possible when auto resize is disabled. | ||
| OtherAddendValuesExceedRange |
There was a problem hiding this comment.
Annoyingly, "addend" refers to both terms in an addition. The first one is called the "augend" but that's not what we care about. Oddly this value thing means that addition of non-resizing histograms is not commutative.
There was a problem hiding this comment.
Huh, interesting. I think that's probably fine though. If I remember correctly, this is the reason I implement only AddAssign, and not Add.
| /// The other histogram includes counts that are higher than the current count for a value, and | ||
| /// counts cannot go negative. The subtraction may have been partially applied to some counts as | ||
| /// this error is returned when the first impossible subtraction is detected. | ||
| SubtrahendCountExceedsMinuendCount |
There was a problem hiding this comment.
For subtraction we can have maximally precise (or pedantic) names, though!
marshallpierce
force-pushed
the
error-enum
branch
from
3115a78
to
942f4f4
Compare
|
This addresses #10. |
|
Looking good! I'd like some better docs for the |
|
I took the liberty of self-bikeshedding on enum names, and also centralized the docs for the |
|
Looks good! |
No description provided.