Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Extend the documentation of PartialOrd #53386
I tried to merge all the comments of https://github.com/LukasKalbertodt/partial-cmp-docs/pull/1/files , but there is still one unresolved issue open by @RalfJung :
Also, i'm not a native speaker, and this is a tricky topic, so it would be cool if someone from the docs team would take a look at this and further process it for easy consumption by users (cc @steveklabnik )
Click to expand the log.
LukasKalbertodt left a comment •
I finally managed to review this. Sorry for the delay!
And thanks a lot for pushing this topic.
I left a few comments. Many are just typos or minor things. However, as you can see below, I'm not quite happy with changes in the module docs -- but maybe it's just me.
Also note that all "I would..." comments should be taken with a grain of salt since I'm not a native speaker.
Oh and maybe you could summarize the prior discussion and what this PR mainly wants to achieve so that @steveklabnik can start reviewing this more quickly.
I feel like the module introduction spends lots of text explaining things most users will not find relevant... all this array sorting and so on.
I would start by introducing the 4 traits, and then explain that the
[transitivity and duality go here]
Then go on about various corollaries (my open issue would be resolved by remarking that transitivity and duality still hold after swapping