Fix bold code formatting in keyword docs #79383
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @shepmaster (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
library/std/src/keyword_docs.rs
Outdated
| /// * <code>for _ **in** 1..3 {}</code> - Iterate over an exclusive range up to but excluding 3. | ||
| /// * <code>for _ **in** 1..=3 {}</code> - Iterate over an inclusive range up to and including 3. |
There was a problem hiding this comment.
Should we just remove the bold? Even though it may remove the emphasis but looks pretty clear to me already, or maybe we bold the in keyword in the details part above in addition to this?
| /// * <code>for _ **in** 1..3 {}</code> - Iterate over an exclusive range up to but excluding 3. | |
| /// * <code>for _ **in** 1..=3 {}</code> - Iterate over an inclusive range up to and including 3. | |
| /// * `for _ in 1..3 {}` - Iterate over an exclusive range up to but excluding 3. | |
| /// * `for _ in 1..=3 {}` - Iterate over an inclusive range up to and including 3. |
There was a problem hiding this comment.
I also thought of just removing the bold instead of writing HTML here. I'll do that.
I'm not sure where exactly you suggest to bold the in keyword in addition to this. I'm not very familiar with the docs.
| @@ -707,8 +707,8 @@ mod impl_keyword {} | |||
| /// | |||
There was a problem hiding this comment.
Just above this line, like **`in`**.
There was a problem hiding this comment.
This style doesn't seem to be used anywhere in this file at least.
I also think removing the bold is enough.
|
@bors r+ rollup |
|
📌 Commit 38cc998 has been approved by |
bors
added
S-waiting-on-bors
|
Thanks! |
…as-schievink Rollup of 10 pull requests Successful merges: - rust-lang#78086 (Improve doc for 'as _') - rust-lang#78853 (rustc_parse: fix ConstBlock expr span) - rust-lang#79234 (Resolve typedefs in HashMap gdb/lldb pretty-printers) - rust-lang#79344 (Convert UNC path to local path to satisfy install script on Windows) - rust-lang#79383 (Fix bold code formatting in keyword docs) - rust-lang#79460 (Remove intermediate vectors from `add_bounds`) - rust-lang#79474 (Change comments on types to doc-comments) - rust-lang#79476 (Sync rustc_codegen_cranelift) - rust-lang#79478 (Expand docs on Peekable::peek_mut) - rust-lang#79486 (Slightly improve code samples in E0591) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
No description provided.