rustdoc: make langstring parsing more robust #14569
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
skade
changed the title
| let mut tokens = string.as_slice().split(|c: char| !c.is_alphanumeric()); | ||
|
|
||
| for token in tokens { | ||
| if token.len() == 0 { |
There was a problem hiding this comment.
This chain could be written as
match token {
"" => {}
"should_fail" => should_fail = true,
"no_run" => ignore = true,
...
_ => notrust = true,
}
|
I fixed and re-indented the code. Also changed the logic a bit: If any of the rustdoc tags are seen, the code is considered rust, even if other unrecognized ones are seen (allowing for .rust .example). |
|
While |
This changes the parsing of the language string in code examples so that unrecognized examples are not considered Rust code. This was, for example, the case when a code example was marked `sh` for shell code. This relieves authors of having to mark those samples as `notrust`. Also adds recognition of the positive marker `rust`. By default, unmarked examples are still considered rust. If any rust-specific tags are seen, code is considered rust unless marked as "notrust". Adds test cases for the detection logic.
|
Sure, I added one with all important examples. |
bors
added a commit
that referenced
this pull request
Jun 2, 2014
…r=alexcrichton This changes the parsing of the language string in code examples so that unrecognized examples are not considered Rust code. This was, for example, the case when a code example was marked `sh` for shell code. This relieves authors of having to mark those samples as `notrust`. Also adds recognition of the positive marker `rust`. By default, unmarked examples are still considered rust.
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.
This changes the parsing of the language string
in code examples so that unrecognized examples
are not considered Rust code. This was, for example,
the case when a code example was marked
shfor shellcode.
This relieves authors of having to mark those samples
as
notrust.Also adds recognition of the positive marker
rust.By default, unmarked examples are still considered rust.