feat: add recent_first alternative sorting arg to ImmudbClient.history() method#59
Open
NickAnderegg wants to merge 1 commit into
Open
feat: add recent_first alternative sorting arg to ImmudbClient.history() method#59NickAnderegg wants to merge 1 commit into
recent_first alternative sorting arg to ImmudbClient.history() method#59NickAnderegg wants to merge 1 commit into
Conversation
Contributor
|
I would suggest to not add another parameter, just operate on the sortorder and make that statement in documentation Adding new parameter, that actually only changes the other parameter is the same as renaming the first parameter, so maybe we should just rename sortorder |
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
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.
The current argument
sortorderinImmudbClient.history()is unclear from its name. Making it more confusing, it's the opposite of the typical Python convention for sort orders, where a boolean affecting sort order is typicallyFalseby default, e.g.:This change adds a new argument,
recent_first, which has the same functionality assortorder, but doesn't require reading the docs to understand what it means. I've implementedrecent_firstas a keyword-only argument and redefinedsortorderas an optional positional-or-keyword argument.This means that existing applications that call this method will be unaffected, but has the added advantage of still working as expected if someone gets confused about the argument names in the future. I've written it so that all of these calls would function identically:
Because effectively specifying
yesornowhen the method askswhat is our sort order?is very confusing!