Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add default sort rules documentation #215

Open
kael89 opened this issue Jan 17, 2021 · 1 comment
Open

Add default sort rules documentation #215

kael89 opened this issue Jan 17, 2021 · 1 comment

Comments

@kael89
Copy link
Contributor

kael89 commented Jan 17, 2021

Thanks for this library, it's very useful! 馃挴

I believe it would be valuable to add documentation about the default rules used for sorting. For example, I was initially a bit confused by the behaviour described in #19. I only realized this was a feature and not a bug after I did some research in this repo and read the code.

I understand that this would essentially repeat a lot of information already in the code, but it may be valuable in the longer term, especially if the core logic does not change often. I'm happy to attempt a PR, if you are interested.

@keithamus
Copy link
Owner

PRs are very much welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants