misc doc improvements#152206
Conversation
rustbot
added
S-waiting-on-review
|
r? @davidtwco rustbot has assigned @davidtwco. Use Why was this reviewer chosen?The reviewer was selected based on:
|
This comment has been minimized.
This comment has been minimized.
|
I’m slightly confused as this PR seems to be mostly adding newlines and commas? We already don’t accept typo fixes because they’re not user-facing and not worth the churn. |
|
|
||
| /// Some features are not allowed to be used together at the same time, if | ||
| /// the two are present, produce an error. | ||
| /// Some features are not allowed to be used together at the same time |
| The Rust compiler maintains a list of unsupported ABIs on for each target. | ||
| If an ABI is present in such a list, this usually means that the |
There was a problem hiding this comment.
The new text has errors (“on for”), and seems less clear than the original.
| /// A pattern newtype. Takes any type and restricts its valid values to its pattern. | ||
| /// A pattern newtype. | ||
| /// | ||
| /// Takes any type and restricts its valid values to its pattern. |
There was a problem hiding this comment.
I am confused by changes like this one.
@tshepang I appreciate your interest in improving our texts (see also your patches elsewhere in the project), but do you think we really need to spend time on nits like these? Can we maybe set a lower bound under which your time (authoring) plus our time (reviewing) is not worth the effort?
just a thought.
There was a problem hiding this comment.
I should have mentioned that it's better reviewed a commit at a time, since each commit message justifies the change
`since` is now a field of one of the parameters
These are a collection of things I fixed when learning how things work. I also decided to not submit them individually since I have seen complaints that such things are too tiny them being their own PRs. Also, here is the guideline, and I have seen it not applied consistently:
I also once asked for clarification on what user-facing means, and that was not answered... perhaps because it was obvious to them. I would think doc-comments are user-facing. The comma changes are readability improvements... they don't count as typos I think. Someone once offered they would be happy accepting such PRs, so I should probably search for their name and assign such PRs them to them, so I don't bother people who don't see such work as valuable enough. |
|
user-facing means its something that a user of the rust language will see. doc comments in the compiler are not something that rust users will ever encounter so aren't user facing, whereas standard library documentation is |
|
@bors r+ rollup |
rust-bors
bot
added
S-waiting-on-bors
misc doc improvements These are things I collected as I was looking at code and docs
misc doc improvements These are things I collected as I was looking at code and docs
…uwer Rollup of 6 pull requests Successful merges: - #152700 (miri subtree update) - #152715 (`rust-analyzer` subtree update) - #152609 (Install LLVM DLL in the right place on Windows) - #152206 (misc doc improvements) - #152664 (Fix mis-constructed `file_span` when generating scraped examples) - #152698 (Suppress unstable-trait notes under `-Zforce-unstable-if-unmarked`)
…uwer Rollup of 6 pull requests Successful merges: - #152700 (miri subtree update) - #152715 (`rust-analyzer` subtree update) - #152609 (Install LLVM DLL in the right place on Windows) - #152206 (misc doc improvements) - #152664 (Fix mis-constructed `file_span` when generating scraped examples) - #152698 (Suppress unstable-trait notes under `-Zforce-unstable-if-unmarked`)
Rollup of 11 pull requests Successful merges: - #152700 (miri subtree update) - #152715 (`rust-analyzer` subtree update) - #151783 (Implement RFC 3678: Final trait methods) - #152512 (core: Implement feature `float_exact_integer_constants`) - #152661 (Avoid ICE in From/TryFrom diagnostic under -Znext-solver) - #152703 (Remove `rustc_query_system`) - #152206 (misc doc improvements) - #152664 (Fix mis-constructed `file_span` when generating scraped examples) - #152698 (Suppress unstable-trait notes under `-Zforce-unstable-if-unmarked`) - #152727 (`probe_op` silence ambiguity errors if tainted) - #152728 (Port #![default_lib_allocator] to the new attribute parser)
Rollup merge of #152206 - tshepang:misc, r=davidtwco misc doc improvements These are things I collected as I was looking at code and docs
8 participants
These are things I collected as I was looking at code and docs