Skip to content

docs(readme): state the Rust version the toolchain actually pins - #5792

Open
ntdatt812 wants to merge 1 commit into
tinyhumansai:mainfrom
ntdatt812:docs/5781-rust-version-readme
Open

docs(readme): state the Rust version the toolchain actually pins#5792
ntdatt812 wants to merge 1 commit into
tinyhumansai:mainfrom
ntdatt812:docs/5781-rust-version-readme

Conversation

@ntdatt812

@ntdatt812 ntdatt812 commented Aug 26, 2026

Copy link
Copy Markdown

Closes #5781.

The defect

All six READMEs told contributors to install Rust 1.93.0. The pin says otherwise, and its own comment says why:

# rust-toolchain.toml
# Rust 1.96 is required by rusqlite 0.40 / libsqlite3-sys 0.38: their build
# scripts use the `cfg_select!` macro, stabilized in 1.96 ...
channel = "1.96.1"

CONTRIBUTING.md:41 already stated 1.96.1, so the two contributor-facing documents disagreed with each other as well as with the pin. A new contributor following the README hit a cfg_select! build failure in libsqlite3-sys on their first cargo check — before writing a line of code.

Verified in-tree

$ grep ^channel rust-toolchain.toml
channel = "1.96.1"

$ grep -n '1\.9[0-9]\.[0-9]' CONTRIBUTING.md
41:| Rust | `1.96.1` from rust-toolchain.toml | ...
62:rustup toolchain install 1.96.1 --profile minimal

$ grep -rn 'Rust 1\.9[0-9]\.[0-9]' README.md docs/README.*.md
README.md:161            ... Rust 1.93.0 ...
docs/README.de.md:158    ... Rust 1.93.0 ...
docs/README.ja-JP.md:158 ... Rust 1.93.0 ...
docs/README.ko.md:158    ... Rust 1.93.0 ...
docs/README.ur-pk.md:204 ... Rust 1.93.0 ...
docs/README.zh-CN.md:158 ... Rust 1.93.0 ...

The change

Six files, one substitution each, nothing else touched — the surrounding prose and every translation are unchanged. grep -rc '1\.93\.0' over the six files returns nothing afterwards.

Summary by CodeRabbit

  • Documentation
    • Updated contribution instructions to require Rust 1.96.1 instead of 1.93.0.
    • Synchronized the prerequisite across English, German, Japanese, Korean, Urdu, and Simplified Chinese documentation.

All six READMEs told contributors to install Rust 1.93.0. rust-toolchain.toml
pins 1.96.1, and its own comment says why: rusqlite 0.40 / libsqlite3-sys 0.38
use `cfg_select!`, stabilized in 1.96. Following the README therefore produced a
build failure in those crates on the very first `cargo check`.

CONTRIBUTING.md already stated 1.96.1, so the two documents disagreed with each
other as well as with the pin.

Closes tinyhumansai#5781
@ntdatt812
ntdatt812 requested a review from a team August 26, 2026 16:17

@tinysweeper tinysweeper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tinysweeper found nothing blocking. Approving.

$0.0000 · 0 in / 0 out

@tinysweeper tinysweeper Bot added the priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect. label Aug 26, 2026
@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2aa8cd28-3e98-4bf0-bce4-ed34c163d45d

📥 Commits

Reviewing files that changed from the base of the PR and between 77fddf5 and ac20235.

📒 Files selected for processing (6)
  • README.md
  • docs/README.de.md
  • docs/README.ja-JP.md
  • docs/README.ko.md
  • docs/README.ur-pk.md
  • docs/README.zh-CN.md

Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

The contributor instructions in the English, German, Japanese, Korean, Urdu, and Chinese READMEs now require Rust 1.96.1 instead of Rust 1.93.0.

Changes

Rust prerequisite documentation

Layer / File(s) Summary
Update contributor prerequisites
README.md, docs/README.de.md, docs/README.ja-JP.md, docs/README.ko.md, docs/README.ur-pk.md, docs/README.zh-CN.md
All six README files now specify Rust 1.96.1. Other documented prerequisites remain unchanged.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to ac202

This localized documentation-only change aligns contributor instructions with the repository's pinned Rust toolchain, with no actionable merge-blocking risk remaining after normal checks and review.

Suggested reviewers: senamakel

Poem

A rabbit checks the Rusty guide,
Six README paths now match inside.
One point nine six, one, bright and clear,
No mismatched version hiding here.
Hop, build, and onward we cheer!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: documenting the Rust version pinned by the toolchain.
Linked Issues check ✅ Passed The PR updates all six README files from Rust 1.93.0 to Rust 1.96.1. This satisfies issue #5781 and aligns the documentation with the pinned toolchain and CONTRIBUTING.md.
Out of Scope Changes check ✅ Passed All six one-line documentation changes directly support issue #5781. No unrelated changes are reported.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

Warning

Your free Security trial is over. An organization admin can activate billing to continue.


Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README says Rust 1.93.0 but rust-toolchain.toml requires 1.96.1

1 participant