Include nonexported macro_rules! macros in the doctest target #96630
Conversation
This file contains 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
rustbot
added
the
T-rustdoc
This comment has been minimized.
This comment has been minimized.
|
I'm no longer part of the rustdoc team, please don't assign me. You can use |
|
r? rust-lang/rustdoc |
m-ysk
commented
May 3, 2022
This comment has been minimized.
This comment has been minimized.
notriddle
approved these changes
May 3, 2022
|
@bors r+ |
|
📌 Commit 4698a3f has been approved by |
bors
added
the
S-waiting-on-bors
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
May 3, 2022
Include nonexported macro_rules! macros in the doctest target Fixes rust-lang#88038 This PR aims to include nonexported `macro_rules!` macros in the doctest target. For more details, please see the above issue.
|
☀️ Test successful - checks-actions |
|
Finished benchmarking commit (3d18f94): comparison url. Summary:
If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf. @rustbot label: -perf-regression Footnotes |
This was referenced May 12, 2022
bors bot
added a commit
to rayon-rs/rayon
that referenced
this pull request
May 12, 2022
935: Convert delegate doctest to unit tests r=cuviper a=cuviper The documented example wasn't functional, and this broke on nightly since rust-lang/rust#96630. We can't actually doctest a nonexported macro, but a unit test will do. Co-authored-by: Josh Stone <cuviper@gmail.com>
cuviper
added
the
relnotes
djkoloski
pushed a commit
to djkoloski/h2
that referenced
this pull request
May 17, 2022
Nightly has begun running doctests for unexported macros as of rust-lang/rust#96630, which caused a doctest for test_unpack_octets_4 which was previously ignored to be run. This broke the CI because macros that are not exported with `#[macro_export]` cannot be used from external crates (and thus cannot be doctested). This change ignores the doctest and copies the relevant code into a unit test.
seanmonstar
pushed a commit
to hyperium/h2
that referenced
this pull request
May 18, 2022
Nightly has begun running doctests for unexported macros as of rust-lang/rust#96630, which caused a doctest for test_unpack_octets_4 which was previously ignored to be run. This broke the CI because macros that are not exported with `#[macro_export]` cannot be used from external crates (and thus cannot be doctested). This change ignores the doctest and copies the relevant code into a unit test. Co-authored-by: David Koloski <dkoloski@google.com>
bors bot
added a commit
to nix-rust/nix
that referenced
this pull request
May 31, 2022
1730: Ignore doctests for unexported macros r=asomers a=zombiepigdragon Due to rust-lang/rust#97030, cargo test will fail to doctest macros unless they are exported, breaking the examples for `libc_bitflags!` and `libc_enum!`. Adds `ignore` to the examples for these macros to stop tests from failing. `cargo test` already fails on cargo 1.62.0-beta.2, and the above issue makes it seem unlikely that this will be changed on the Rust side. If rust-lang/rust#96630 *does* get reverted, this PR can be closed/unmerged, although the test wasn't running beforehand, and it might be worth making this explicit regardless. Co-authored-by: Alex Rawson <ajzecrom@gmail.com>
Xiretza
added a commit
to Xiretza/sodiumoxide
that referenced
this pull request
Jun 15, 2022
Since Rust 1.62.0, doctests on macros are run even if the macro isn't marked #[macro_export] [0]. Because the macro can't actually be accessed externally, we explicitly mark the doctest as ignored so it continues not to be run. [0]: rust-lang/rust#96630
Xiretza
added a commit
to Xiretza/sodiumoxide
that referenced
this pull request
Jun 15, 2022
Since Rust 1.62.0, doctests on macros are run even if the macro isn't marked #[macro_export] [0]. Because the macro can't actually be accessed externally, we explicitly mark the doctest as ignored so it continues not to be run. [0]: rust-lang/rust#96630
|
This PR has a |
|
Probably not - could you file an issue on the release team repo for us to investigate? |
|
This repo? (I’m asking because there’s not too many issues over there.) |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jul 1, 2022
Add macro_rules! rustdoc change to 1.62 relnotes rust-lang#96630 was tagged <kbd>relnotes</kbd> but didn't make it into the notes. Given this is a compatibility issue (rust-lang#97030, rust-lang#98735, rust-lang#98743), it probably *should* be retroactively added.
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.
Fixes #88038
This PR aims to include nonexported
macro_rules!macros in the doctest target. For more details, please see the above issue.