petl-developers / petl / 38113002324

94%

push

github

Document sorting fields in different directions (#740)

This PR has the objective of documenting how to sort by several fields
in different directions with `sort()`, as asked in #375 ("re-opening as
a reminder to modify the sort() docstring with an example").

## Changes

1. Improved the docs about `sort()`: a doctest example showing that,
since sorting is stable, fields can be sorted in different directions by
chaining sorts, starting with the last field (`etl.sort(table1,
'bar').sort('foo', reverse=True)`).
2. Added tests that pin the stability this relies on, both for the
in-memory sort and when the rows spill to temporary files (small
`buffersize`).

No behavior changes.

Closes #375

Co-authored-by: Juarez Rudsatz <juarezr@gmail.com>

12 of 12 new or added lines in 1 file covered. (100.0%)

15399 of 16628 relevant lines covered (92.61%)

0.93 hits per line