rust-lang / rust-lang/rust

Broken std docs for ExitCode: wrong rust version for PartialEq impl

Open
#146,264 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Location (URL)

https://doc.rust-lang.org/stable/std/process/struct.ExitCode.html#impl-PartialEq-for-ExitCode

Summary

The docs claim ExitCode has had PartialEq since 1.61.0:

Image

This is not true, that impl was only added in 1.83.0 (see https://releases.rs/docs/1.83.0/).

This means the versions listed by rustdoc are currently buggy and unreliable if you wish to determine what feature you can depend upon wrt 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

Start with the ExitCode documentation at the linked std URL and compare its PartialEq version marker with the 1.83.0 release entry at releases.rs. Correct the version metadata so the generated docs report 1.83.0, then verify the rendered API documentation no longer says 1.61.0.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.