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

Bugfix for text codeblock in documentation. #286

Merged
merged 1 commit into from
Sep 18, 2023

Conversation

robamu
Copy link
Contributor

@robamu robamu commented Sep 18, 2023

Fixes #285 .
From what I have seen, the local output generated with cargo +nightly doc --open (rustc v1.74.0 nightly 203c57dbe) does not look differently than the most current one found here: https://docs.rs/num-traits/latest/num_traits/identities/trait.One.html

Propably related to rust-lang/rust#110800 ? If it is, then the issue might be fixed soon and this PR should be ignored..

@cuviper
Copy link
Member

cuviper commented Sep 18, 2023

Looks like rust-lang/rust#115914 just relaxed that to a warning, but that's still annoying. Since your change has the right formatting without warning or error, even on older Rust, it's a reasonable change anyway. Thanks!

bors r+

@bors
Copy link
Contributor

bors bot commented Sep 18, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit ef36d69 into rust-num:master Sep 18, 2023
1 check passed
@kangalio
Copy link

Could a new patch release with this PR be pushed out soon? This presumably breaks CI workflow in many crates

@OliverKillane
Copy link

@robamu could this be released as num-traits-0.2.17?

@robamu
Copy link
Contributor Author

robamu commented Oct 7, 2023

I am not a maintainer of this crate. @cuviper is probably the better person to ask.

@cuviper cuviper mentioned this pull request Oct 7, 2023
bors bot added a commit that referenced this pull request Oct 7, 2023
289: Release 0.2.17 r=cuviper a=cuviper

- [Fix a doc warning about custom classes with newer rustdoc.][286]

[286]: #286

Co-authored-by: Josh Stone <cuviper@gmail.com>
@cuviper
Copy link
Member

cuviper commented Oct 7, 2023

Published via #289.

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.

cargo doc fails if they run it with nightly Rust
4 participants