Crate's docs.rs page irritatingly empty
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation, web-dev
Research direction
Start by opening the linked docs.rs pages and using the Platform drop-down to reproduce the empty default view and the available non-empty variants. Read the issue's proposed browser-based platform selection and fallback message requirements; done means an appropriate non-empty platform is selected when possible, with clear guidance when another variant must be chosen.
Written by the indexing model from the issue text.
Description
Only after much irritation, I understood that using #![cfg(target_os = "windows")] is responsible for my crates https://docs.rs/win-beep/latest/win_beep/ and https://docs.rs/vcvars/latest/vcvars/ showing empty documentation. How must it be for a potential user of the crates?
I read that using #![cfg(target_os = "windows")] is better than causing compiler errors in a crate dependency (the crate being the dependency of others).
I now know that I can show the documentation by choosing an entry from the "Platform" drop-down menu (the entries are quite cryptic though, easily scaring you off). But I think docs.rs should, e.g., automatically choose a non empty "Platform" entry to be displayed.
Maybe it would be best to choose a platform that corresponds to what can be retrieved from the running browser (favoring 64 bits, of course, if this info can't be retrieved). And if that would result in an empty crate, show a message, if true, that there are other non-empty crate variants behind the "Platform" drop-down menu.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 235
- Avg merge
- 11h 56m
- Merged PRs (30d)
- 78
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from rust-lang/docs.rs
-
Add a changelogOpenC-technical-debt E-easy mentor P-medium
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
rust-lang/docs.rs#1013 · 5 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 52/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 53/100
Maintainers usually reply within 1 day
All issues in rust-lang/docs.rs
Similar issues
-
good first issue help wanted program
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
hffgzktbcc-blip/ounce-core#297 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
nautechsystems/nautilus_trader#5631 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
bytecodealliance/rustix#1736 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
longbridge/gpui-kit#3871 ·
Maintainers usually reply within 1 day
-
area:models enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day