Rollup of 15 pull requests #27380
Merged
Rollup of 15 pull requests #27380
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This only reads five bytes, so don't use a ten byte buffer, that's confusing.
This isn't a standard header, and the other docs don't use it, so let's remove it.
How embarassing 😭
The first paragraph of the docs of the Cursor struct contains a Markdown link. In listings, this won't get rendered. (Rustdoc seems to split off the first paragraph and after that convert Markdown to HTML.)
Mostly by splitting error messages into proper pairs of errors and helps
The reader could probably infer this from the current text, but for C++ programmers it's not obvious that struct fields don't automatically become public. Apparently I wasn't the only one to be confused: http://stackoverflow.com/questions/29157300/field-of-struct-is-private-when-importing-module I don't think an example is necessary, but can add one if desired. r? @steveklabnik
Improves diagnostics in various locations, namely: * A few error messages that orignally were a mix of an error message and suggestion how to fix it have been split up into two messages: an error and help/hint. * Never report “illegal”. Fixes rust-lang#27288
In spirit with https://internals.rust-lang.org/t/should-we-keep-including-obvious-imports-in-code-examples/2217, show the feature flags we're using in examples. (also one instance of 'use')
This only reads five bytes, so don't use a ten byte buffer, that's confusing. r? @alexcrichton
…crichton This isn't a standard header, and the other docs don't use it, so let's remove it.
How embarassing 😭 r? @alexcrichton
The first paragraph of the docs of the Cursor struct ([src](https://github.com/rust-lang/rust/blob/ff6c6ce917bd6af9c5d9315708ae6be3ba0b7e91/src/libstd/io/cursor.rs#L18-L21)) contains a Markdown link. In listings (like <http://doc.rust-lang.org/nightly/std/io/>), this won't get rendered:  The hotfix would be to change the link by reference: ```rust /// A `Cursor` wraps another type and provides it with a [`Seek`][seek] /// implementation. /// /// [seek]: trait.Seek.html ``` to a direct link: ```rust /// A `Cursor` wraps another type and provides it with a /// [`Seek`](trait.Seek.html) implementation. ``` _I have not tested this as I don't have access to a machine for compiling Rust right now._ (This seems to be a more general issue, but I think I have seen this mentioned before. This PR is just to hotfix on particular occurrence. Rustdoc seems to only read the first paragraph of a doc string for the description in index pages, and _after that_ convert Markdown to HTML.) r? @steveklabnik
Minor change in the book
…xcrichton FreeBSD uses ash, not bash. The double bracket operators [[ and ]] are not supported.
Noticed that syntax like `vec![0; 5]` is never mentioned in `Vec<T>`'s docs, nor used in any of its methods' docs, so I figured I should add a mention of it. Also noticed `vec!(1, 2)` being used in one spot while I was at it, so I fixed that as well for consistency's sake. r? @steveklabnik
As described in the module documentation, the memory orderings in Rust are the same with that of LLVM. However, the documentation for the memory orderings enum says the memory orderings are the same of that of C++. Note that they differ in that C++'s support the consume reads, while LLVM's does not. Hence this commit fixes the bug in the documentation for the enum.
|
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
|
@bors: r+ p=10000 |
|
📌 Commit 5944303 has been approved by |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
pubfor structs and fields #27286, Assorted diagnostics improvements #27313, Fix misrendered HTML character entities #27325, Show appropriate feature flags in docs #27326, Fix buffer length in std::io::take #27327, Remove warning header for consistency #27341, fix two links #27342, remove incorrect statement from TRPL: crates and modules #27343, IO Docs: Fix Link in Cursor description #27345, Improve E0119 error explanation #27350, more precise for inclusive range #27355, recent changes to search for gcc/clang on freebsd and this fixes #14381 #27374, Docs: Mention vec![x; len] syntax in Vec<T> docs, fix inconsistent use #27375, Fix a documentation bug for memory orderings #27379