Skip to content

Fully remove notrust markers from rustdoc #20075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 23, 2014
Merged

Conversation

skade
Copy link
Contributor

@skade skade commented Dec 20, 2014

Internally refactor all mentions of notrust to the
positive statement rust.

[breaking-change] Change remaining notrust markers to
the thing they actually represent, e.g. sh or plain.

This supersedes #19693 .

@rust-highfive
Copy link
Contributor

r? @huonw

(rust_highfive has picked a reviewer for you, use r? to override)

@steveklabnik
Copy link
Member

🎊

@alexcrichton
Copy link
Member

I think that this technically actually isn't a breaking change because the marker "notrust" is now just like any other tag which indicates "this is not rust". Would you be ok removing the [breaking-change] annotation from the commit? Thanks for this!

Internally refactor all mentions of `notrust` to the
positive statement `rust`.
@skade
Copy link
Contributor Author

skade commented Dec 21, 2014

@alexcrichton right. No logic after 24:00 for me ;).

Removed.

@alexcrichton
Copy link
Member

Thanks!

alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 22, 2014
Internally refactor all mentions of `notrust` to the
positive statement `rust`.

[breaking-change] Change remaining `notrust` markers to
the thing they actually represent, e.g. `sh` or `plain`.

This supersedes rust-lang#19693 .
@bors bors merged commit ee9de3b into rust-lang:master Dec 23, 2014
bors added a commit that referenced this pull request Dec 26, 2014
#20075 introduced a bug where unmarked code fences weren't considered as doctests. This PR fixes the logic.

---

This passed `check-stage1-rustdoc`, and I manually checked that:

``` rust
//! ```
//! println!("Hello")
//! ```
//!
//! ``` rust
//! println!("Hello")
//! ```
//!
//! ``` sh
//! println!("Hello")
//! ```
//!
//! ``` ignore
//! println!("Hello")
//! ```
```

Generated:

``` rust
running 3 tests
test _2 ... ignored
test _0 ... ok
test _1 ... ok
```

I'd love to add that as a test, but I have no idea how to do that with our testing infrastructure. If anyone knows how, do let me know!

r? @alexcrichton 
@seanmonstar feedback?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants