rust-lang / rust-lang/stdarch

Broken docs for std-detect on docs.rs

Open
#1,799 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
694
Forks
336
Avg merge
5d 14h
Merged PRs (30d)
9

Description

https://docs.rs/crate/std_detect/latest reads:

"std_detect-0.1.5 doesn't have any documentation".

I suspect this is what breaks the source link from https://doc.rust-lang.org/stable/std/macro.is_x86_feature_detected.html

(Why that points to "latest" instead of the version std actually uses I have no idea, that seems quite unfortunate).

See also rust-lang/rust#141102 which is how I discovered this.

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 by opening the docs.rs page for std_detect 0.1.5 and the source link from std::is_x86_feature_detected; compare how the crate is published and how the stable standard-library documentation references it. Check rust-lang/rust#141102 for related context. Done means the std_detect documentation appears on docs.rs and the standard-library source link resolves to the intended version.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.