Found a minor Javadoc vs implementation discrepancy. #435
Merged
Conversation
getQuantiles(int numEvenlySpaced) methods and the implementation of the QuantilesUtil.evenlySpaced(...) method. The javadocs of the getQuantiles methods (for all quantiles sketches) claimed that a "numEvenlySpaced == 1" was valid, yet the implementation would throw an exception if "numEvenlySpaced < 2". So I updated the implementation so that the implementation matched the javadocs. I also updated the relevant quantiles javadocs to reflect that this exception could be thrown. The only place this QuantilesUtil.evenlySpaced(...) method was used was for these quantiles methods, so no place else in the library used this method.
accidentally used a "<" in javadocs.
davecromberge
approved these changes
Mar 20, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is WRT getQuantiles(int numEvenlySpaced) methods and the implementation of the QuantilesUtil.evenlySpaced(...) method.
The javadocs of the getQuantiles methods (for all quantiles sketches) claimed that a "numEvenlySpaced == 1" was valid, yet the implementation would throw an exception if "numEvenlySpaced < 2".
So I updated the implementation so that the implementation matched the javadocs.
I also updated the relevant quantiles javadocs to reflect that this exception could be thrown.
The only place this QuantilesUtil.evenlySpaced(...) method was used was for these quantiles methods, so no place else in the library used this common method.