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.

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

New nightly version broke cargo-doc, unintended use of unstable feature #287

Closed
marcospb19 opened this issue Sep 18, 2023 · 3 comments
Closed

Comments

@marcospb19
Copy link

marcospb19 commented Sep 18, 2023

Crate version: 0.2.16 (latest).
Cargo version: nightly from today (cargo 1.74.0-nightly (d5336f813 2023-09-14)).

I'm getting an error when trying to run cargo doc in a crate.

cargo doc
# or
cargo doc -p num-traits
 Documenting num-traits v0.2.16
error[E0658]: custom classes in code blocks are unstable
  --> /home/marcospb19/.cargo/registry/src/index.crates.io-6f17d22bba15001f/num-traits-0.2.16/src/identities.rs:4:1
   |
4  | / /// Defines an additive identity element for `Self`.
5  | | ///
6  | | /// # Laws
7  | | ///
...  |
10 | | /// 0 + a = a       ∀ a ∈ Self
11 | | /// ```
   | |_______^
   |
   = note: see issue #79483 <https://github.com/rust-lang/rust/issues/79483> for more information
   = help: add `#![feature(custom_code_classes_in_docs)]` to the crate attributes to enable
   = note: found these custom classes: class=text

error[E0658]: custom classes in code blocks are unstable
  --> /home/marcospb19/.cargo/registry/src/index.crates.io-6f17d22bba15001f/num-traits-0.2.16/src/identities.rs:80:1
   |
80 | / /// Defines a multiplicative identity element for `Self`.
81 | | ///
82 | | /// # Laws
83 | | ///
...  |
86 | | /// 1 * a = a       ∀ a ∈ Self
87 | | /// ```
   | |_______^
   |
   = note: see issue #79483 <https://github.com/rust-lang/rust/issues/79483> for more information
   = help: add `#![feature(custom_code_classes_in_docs)]` to the crate attributes to enable
   = note: found these custom classes: class=text

For more information about this error, try `rustc --explain E0658`.
error: could not document `num-traits`

Therefore, I cannot see the docs for my crate.

@marcospb19 marcospb19 changed the title Cargo doc is broken due to use of unstable feature Cargo doc is broken due to unintended use of unstable feature Sep 18, 2023
@marcospb19 marcospb19 changed the title Cargo doc is broken due to unintended use of unstable feature Nightly broke cargo-doc, unintended use of unstable feature Sep 18, 2023
@marcospb19 marcospb19 changed the title Nightly broke cargo-doc, unintended use of unstable feature New nightly version broke cargo-doc, unintended use of unstable feature Sep 18, 2023
@marcospb19
Copy link
Author

marcospb19 commented Sep 18, 2023

Fixed by #286.

@cuviper I'd recommend keeping this open (or closed + pinned) to be a guide towards the fix once it is published, this is probably going to hit a lot of people.

@kangalio
Copy link

kangalio commented Sep 18, 2023

Also hitting this in serenity-rs/poise#204

@cuviper
Copy link
Member

cuviper commented Sep 19, 2023

rust-lang/rust#115914 relaxed this to a warning, shipped in rustc 1.74.0-nightly (65ea825f4 2023-09-18). Furthermore, that seems to now respect cap-lints, so you shouldn't even see the warning here unless you use cargo doc -v -v.

@cuviper cuviper closed this as completed Sep 19, 2023
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

No branches or pull requests

3 participants