Tracking issue for release notes of #159014: [rustdoc] Do not take `doc(cfg())` into account when filtering doctests

Open Beginner friendly
#162,963 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation, release

Research direction

Start with the Release notes text section in this issue, then read the linked Forge release-notes chapter and previous releases for category and wording conventions. Review the proposed rustdoc entry and release blog section, making any needed edits so the change is accurately categorized and succinctly described; leave the blog section empty if it is not notable enough.

Written by the indexing model from the issue text.

Description

A-run-make needs-triage O-hermit O-linux O-netbsd O-redox O-SGX O-solid O-unix O-wasi O-wasm O-windows relnotes relnotes-tracking-issue T-compiler T-rustdoc

This issue tracks the release notes text for #159014.

cc @GuillaumeGomez, @Urgau -- original issue/PR authors and assignees for drafting text

See the forge.rust-lang.org chapter about release notes for an overview of how the release team makes use of these tracking issues.

Release notes text

This section should be edited to specify the correct category(s) for the change, with succinct description(s) of what changed. Some things worth considering:

  • Does this need an additional compat notes section?
  • Was this a libs stabilization that should have additional headers to list new APIs under Stabilized APIs and Const Stabilized APIs?
# Language/Compiler/Libraries/Stabilized APIs/Const Stabilized APIs/Rustdoc/Compatibility Notes/Internal Changes/Other
- [[rustdoc] Do not take `doc(cfg())` into account when filtering doctests](https://github.com/rust-lang/rust/pull/159014)

[!TIP]
Use the previous releases for inspiration on how to write the release notes text and which categories to pick.

Release blog section

If this change is notable enough for inclusion in the blog post then this section should be edited to contain a draft for the blog post. Otherwise leave it empty.

We used to take `doc(cfg())` into account to check whether or not a doctest should be run, but it was a bug. Now, if the item is available under the current `cfg`, its doctests will be run. If you want a doctest to be run on windows for example, you can do:

```rust
/// doc
///
#[cfg_attr(windows, doc = "```")]
#[cfg_attr(not(windows), doc = "```ignore")]
/// let x = 12;
/// ```
pub struct Foo;
```

Like that, if not on windows, the doctest will be ignored.

[!NOTE]

If a blog post section is required the release-blog-post label should be added (@rustbot label +release-blog-post) to this issue as otherwise it may be missed by the release team.

Dominant language
Rust
Stars
119k
Forks
16.2k
Avg merge
2d 11h
Merged PRs (30d)
510

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/rust

All issues in rust-lang/rust

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.