Sort crate features by name#1320
Sort crate features by name#1320apiraino wants to merge 1 commit intorust-lang:masterfrom apiraino:sort-crate-features-by-name
Conversation
This patch changes one detail implemented in #1144. The features flag sorting was by "number of subfeatures". Now it by feature alphabetically. It also ensure that the "default" feature stays on top of the list.
| } else { | ||
| a.name.partial_cmp(&b.name).unwrap() | ||
| } | ||
| }); |
There was a problem hiding this comment.
at first I've tried to simply change the sorting at the SQL level on line 55 but I think this sorting in this function would neutralize it anyway
|
How the sorting looks before this patch Details
How the sorting looks after this patch Details
|
|
Thank you for including me. I don't mind this change, I am not sure if the requirement has changed since the initial implementation. |
@almusil good point, I forgot to give some context. Example: I went to the tokio crate feature list (see my screenshots) looking for a specific one and I was confused because I expected them in alphabetical order, so I had to run This may be a subjective "feeling" on how I see the sorting and this PR is just a small question+proposal, this is why I mentioned it's perfectly fine to decline this PR :) Meta-thought: it's often hard to please every and each user, often there are conflicting thoughts about a UX/UI :) The expectations of a single user (in this case: me) should not put anyone under pressure to accept a PR. |
The idea was to have flat tree structure of features that are enabled by default followed by features that enable any other feature.
I understand that, this is worth a discussion.
|
|
Personally I like the tree structure better, I think it shows the features you'd want most often towards the top. If the crate has really complicated features, I think it should be documenting those itself anyway. |
Based on your reasoning, I think you have a stronger case to keep it as it is, so I'll close my proposal. (thanks @jyn514 for your thoughts on the matter) |
4 participants
This patch changes one detail implemented in #1144. The feature flags
sorting was by "number of subfeatures". Now it is by feature alphabetically
which I find suitable to easily discover the feature I'm looking for in a crate.
It also ensures that the special "default" feature stays on top of the list.
If we don't want to touch this behaviour, I'm also 100% ok to decline.
If there is a better way to implement this I'm happy to improve it.
cc @almusil since author of the original patch
super-thanks to @GuillaumeGomez for mentoring me on this!
r? @GuillaumeGomez or @jyn514