Docs for reexport sometimes have broken links
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.2k
- PR merge metrics
- PR metrics pending
Description
Compare https://docs.rs/libc/0.2.182/libc/enum.c_void.html with https://doc.rust-lang.org/std/ffi/enum.c_void.html - the former has
Equivalent to C’s void type when used as a [pointer].
while the later has
Equivalent to C’s void type when used as a pointer.
The link should be fixed in the docs.rs documentation for the crate
Reported for libc in rust-lang/libc#4978 and instructed by @tgross35 to file an issue here
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the c_void pages on docs.rs and doc.rust-lang.org shown in the report, then trace how rustdoc generates links for reexported documentation. Done means the docs.rs output preserves the target for the pointer link, matching the standard-library page; no source file or test is named.
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