rustdoc: tweak notes on ignore/compile_fail examples #45815
Merged
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
|
r? @frewsxcv (rust_highfive has picked a reviewer for you, use r? to override) |
|
@rust-lang/docs These strings are being stirred up again, what do you think of these updates? |
| @@ -228,9 +228,9 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'a, I> { | |||
| )) | |||
| }); | |||
| let tooltip = if ignore { | |||
| Some(("Be careful when using this code, it's not being tested!", "ignore")) | |||
| Some(("This example is not tested", "ignore")) | |||
There was a problem hiding this comment.
I'm not a big fan of this new sentence. :-/
| } else if compile_fail { | ||
| Some(("This code doesn't compile so be extra careful!", "compile_fail")) | ||
| Some(("This example deliberately fails to compile", "compile_fail")) |
|
Oh right, there's a test for the warning text, so travis failed because i didn't change it: |
kennytm
added
the
S-waiting-on-author
frewsxcv
approved these changes
Nov 7, 2017
|
triage ping for you @QuietMisdreavus! ❤️ |
|
I've pushed a commit that fixes the test. @GuillaumeGomez Do you have any specific concerns about the new text, or are you okay with this landing? AFAIK @frewsxcv wanted to make sure you were okay with the changes before approving. |
kennytm
added
S-waiting-on-review
|
Oops sorry! The current text is fine for me so let's merge. @bors: r+ rollup |
|
📌 Commit 02b3785 has been approved by |
kennytm
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Nov 14, 2017
…s, r=GuillaumeGomez rustdoc: tweak notes on ignore/compile_fail examples Part of rust-lang#44927 This is a softening of these notices to mention *why* a given example has a given callout, rather then telling viewers to be careful with an example. It also changes the character used for these samples from a warning logo to a circle-i/information logo. 
bors
added a commit
that referenced
this pull request
Nov 14, 2017
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Nov 14, 2017
…s, r=GuillaumeGomez rustdoc: tweak notes on ignore/compile_fail examples Part of rust-lang#44927 This is a softening of these notices to mention *why* a given example has a given callout, rather then telling viewers to be careful with an example. It also changes the character used for these samples from a warning logo to a circle-i/information logo. 
bors
added a commit
that referenced
this pull request
Nov 14, 2017
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.
Part of #44927
This is a softening of these notices to mention why a given example has a given callout, rather then telling viewers to be careful with an example. It also changes the character used for these samples from a warning logo to a circle-i/information logo.