rust-lang / rust-lang/rust

Allow way to get merged doctests while developing on latest when MSRV doesn't support 2024 Edition

Open
#141,240 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-doctests C-feature-request T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Many of the example packages used when showing the value of merged doctests run on an old MSRV and can't benefit from it. I'd go so far as to presume that the packages with the most doctests are likely the most mature and therefore have the most demand for a low MSRV. This prevents those that need it the most to use this feature.

jiff works around this by having CI inject an edition = "2024" but that doesn't work for local development without special knowledge to do so and the risk of merging it.

It would be helpful to have a way to explicitly opt-in to merged doctests without bumping MSRV.

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.

Research direction

The issue names no files, tests, or entry points. Start by tracing merged-doctest handling alongside edition and MSRV validation; done means an explicit opt-in works during local development without requiring a 2024-edition MSRV or CI-only injection.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.