feat: add recent_first
alternative sorting arg to ImmudbClient.history()
method
#59
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
sortorder
inImmudbClient.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 typicallyFalse
by 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_first
as a keyword-only argument and redefinedsortorder
as 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
yes
orno
when the method askswhat is our sort order?
is very confusing!