larray-project / larray

N-dimensional labelled arrays in Python
https://larray.readthedocs.io/
GNU General Public License v3.0
8 stars 6 forks source link

Update sorting section of the tutorial #1042

Open gdementen opened 2 years ago

gdementen commented 2 years ago

https://larray.readthedocs.io/en/stable/tutorial/tutorial_transforming.html#Sorting

@alixdamman : What do you think about these points?

alixdamman commented 2 years ago

Use 1D examples first (or only?)

It doesn't hurt to have 2 examples: 1D and 2D

Add example of sort_values(axis=)

OK

do not show example of sort_values(key=) (it seems extremely niche to me)

I hesitate. It doesn't hurt to know that it exists but we should limit to a 1D example.