Skip to content

libstd doc: uniform modules titles #11134

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2013
Merged

libstd doc: uniform modules titles #11134

merged 1 commit into from
Dec 29, 2013

Conversation

lucab
Copy link
Contributor

@lucab lucab commented Dec 24, 2013

Uniform the short title of modules provided by libstd, in order to make their roles more explicit when glancing at the index.

@@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Utilities for manipulating the char type
//! Utilities for manipulating UTF-8 characters (`char` type)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent with at_vec; I prefer the at_vec style (just char)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I take it back; fix at_vec, not the rest

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it should be "Unicode characters" or "codepoints"? UTF-8 is just an encoding.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manual calls them "Unicode characters", and so will I.

@emberian
Copy link
Member

Thanks! r+ once the nits are fixed.

@kud1ing
Copy link

kud1ing commented Dec 25, 2013

I am a bit concerned about prefixes like "Utilities for" because I think they bear a reading cost when browsing the index while not providing much information in return.

@huonw
Copy link
Member

huonw commented Dec 25, 2013

@kud1ing++

I personally think that modules that actually define the types in question (e.g. Option, Either etc) are not just "utilities". (They could just be e.g. "the Option type to represent nullable values".)

@lucab
Copy link
Contributor Author

lucab commented Dec 26, 2013

@kud1ing and @huonw thanks both for the feedback, I've reworded all the trailing "utilities" in type-introducing modules for compactness, but left the "(foo type)" suffix for coherency.

@emberian
Copy link
Member

@lucab needs a rebase

@lucab
Copy link
Contributor Author

lucab commented Dec 26, 2013

Rebased.

This commit uniforms the short title of modules provided by libstd,
in order to make their roles more explicit when glancing at the index.

Signed-off-by: Luca Bruno <[email protected]>
@lucab
Copy link
Contributor Author

lucab commented Dec 28, 2013

Oh my bad, a trailing whitespace. Fixed.

bors added a commit that referenced this pull request Dec 29, 2013
Uniform the short title of modules provided by libstd, in order to make their roles more explicit when glancing at the index.
@bors bors closed this Dec 29, 2013
@bors bors merged commit a9a7a42 into rust-lang:master Dec 29, 2013
@lucab lucab deleted the lucab/libstd-doc branch January 5, 2014 09:53
flip1995 pushed a commit to flip1995/rust that referenced this pull request Oct 21, 2023
Fix/11134

Fix rust-lang#11134

Hir of `qpath` will be `TypeRelative(Ty { kind: Path(LangItem...` when a closure contains macro (e.g. rust-lang/rust-clippy#11651) and rust-lang#11134, it causes panic.
This PR avoids panicking and emitting incomplete path string when `qpath` contains `LangItem`.

changelog: none
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

Successfully merging this pull request may close these issues.

6 participants