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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Manual: Give lists of items/attributes some type of order #16414

Closed
16 tasks done
mdinger opened this issue Aug 11, 2014 · 0 comments · Fixed by #16780
Closed
16 tasks done

Manual: Give lists of items/attributes some type of order #16414

mdinger opened this issue Aug 11, 2014 · 0 comments · Fixed by #16780

Comments

@mdinger
Copy link
Contributor

mdinger commented Aug 11, 2014

Lists of items on the std docs should be sorted in some fashion. Alphabetical sorting throughout may not be desirable but I thought I should list all of them here anyway. If other sorting methods are better, I could create more categories.

Lists which are sorted alphabetically:

In Marker types:

no_copy_bound : This type does not implement "copy", even if eligible
no_send_bound : This type does not implement "send", even if eligible
no_sync_bound : This type does not implement "sync", even if eligible
managed_bound : This type implements "managed"

managed_bound should be first.
@mdinger mdinger mentioned this issue Aug 11, 2014
Merged
@mdinger mdinger changed the title Std docs: Give lists of items/attributes some type of order Manual: Give lists of items/attributes some type of order Aug 11, 2014
bors added a commit that referenced this issue Aug 14, 2014
@bors
auto merge of #16428 : mdinger/rust/sort_attributes, r=cmr
259e806 
Targetting at fixing most of #16414.

Sorts these alphabetically:
* [Crate-only attributes](http://doc.rust-lang.org/rust.html#crate-only-attributes)
* [Function-only attributes](http://doc.rust-lang.org/rust.html#function-only-attributes)
* [Miscellaneous attributes](http://doc.rust-lang.org/rust.html#miscellaneous-attributes)
* [Lint check attributes](http://doc.rust-lang.org/rust.html#lint-check-attributes)
* [Built-in Traits](http://doc.rust-lang.org/rust.html#built-in-traits)
* [Types](http://doc.rust-lang.org/rust.html#types)
* [Deriving](http://doc.rust-lang.org/rust.html#deriving)
* [Compiler Features](http://doc.rust-lang.org/rust.html#compiler-features)

Doesn't modify these:
* [Operators](http://doc.rust-lang.org/rust.html#operators): An alternative sorting is unclear.
* [Marker types](http://doc.rust-lang.org/rust.html#marker-types): Could be sorted but uncertain how. See below.
* [Stability](http://doc.rust-lang.org/rust.html#stability): Already sorted by stability

---

[Marker types](http://doc.rust-lang.org/rust.html#marker-types) has an extra newline above `fail_` which may throw off formatting (see #16412) or it may be for some other reason. If the newline is just a typo, I can just remove it and format this alphabetically like so:
```rust
// Sorted alphabetically
a_bread
b_bread
c_bread
fail_
fail_bounds_check
a_type
b_type
c_type
```

Marker types is listed as likely to become out of date so I don't know if this is worth doing anyway.

[EDIT] modified `Marker types` now and tried to update the language items list.
@mdinger mdinger mentioned this issue Aug 27, 2014
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Manual: Change Language items sync to share. Fix minor sorting mistake mdinger/rust
1 participant
@mdinger