Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Unstable Book: "foo" leads to an unrelated tracking issue, it's not a real feature #76246

Closed
ArekPiekarz opened this issue Sep 2, 2020 · 0 comments · Fixed by #84531
Closed

Unstable Book: "foo" leads to an unrelated tracking issue, it's not a real feature #76246

ArekPiekarz opened this issue Sep 2, 2020 · 0 comments · Fixed by #84531
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.

Comments

@ArekPiekarz
Copy link
Contributor

The Unstable Book in section foo leads to a tracking issue #1234, which is about an unrelated topic rust-mac1 bot has issues. The naming of both the feature and the issue leads me to believe they are only given as examples in the code and are being incorrectly picked up by the documentation generator as real ones.

For instance they are used in library/core/src/intrinsics.rs:

//! In order to make an intrinsic usable at compile-time, one needs to copy the implementation
//! from https://github.com/rust-lang/miri/blob/master/src/shims/intrinsics.rs to
//! `librustc_mir/interpret/intrinsics.rs` and add a
//! `#[rustc_const_unstable(feature = "foo", issue = "01234")]` to the intrinsic.
@camelid camelid added C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Oct 20, 2020
@syvb syvb mentioned this issue Apr 24, 2021
Merged
m-ou-se added a commit to m-ou-se/rust that referenced this issue Apr 28, 2021
@m-ou-se
Rollup merge of rust-lang#84531 - Smittyvb:foo-not-feature, r=Mark-Si…
4b58aec 
…mulacrum

Ignore commented out lines when finding features

This fixes rust-lang#76246, where commented out lines were being detected as features by `tidy`, by ignoring those lines when looking for features. It's still not perfect, since it can be fooled by things like:
```rust
/*
#[unstable(feature = "foo", issue = "1234")]
*/
```
But luckily that never happens in `rustc`, so `foo` now ceases to appear in the unstable book.
jackh726 added a commit to jackh726/rust that referenced this issue Apr 28, 2021
@jackh726
Rollup merge of rust-lang#84531 - Smittyvb:foo-not-feature, r=Mark-Si…
7c9f535 
…mulacrum

Ignore commented out lines when finding features

This fixes rust-lang#76246, where commented out lines were being detected as features by `tidy`, by ignoring those lines when looking for features. It's still not perfect, since it can be fooled by things like:
```rust
/*
#[unstable(feature = "foo", issue = "1234")]
*/
```
But luckily that never happens in `rustc`, so `foo` now ceases to appear in the unstable book.
jackh726 added a commit to jackh726/rust that referenced this issue Apr 29, 2021
@jackh726
Rollup merge of rust-lang#84531 - Smittyvb:foo-not-feature, r=Mark-Si…
d6a8458 
…mulacrum

Ignore commented out lines when finding features

This fixes rust-lang#76246, where commented out lines were being detected as features by `tidy`, by ignoring those lines when looking for features. It's still not perfect, since it can be fooled by things like:
```rust
/*
#[unstable(feature = "foo", issue = "1234")]
*/
```
But luckily that never happens in `rustc`, so `foo` now ceases to appear in the unstable book.
@bors bors closed this as completed in 4da8c22 Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ignore commented out lines when finding features syvb/rust
2 participants
@ArekPiekarz @camelid