kind filters are insufficently documented
Open
Nobody has claimed this yet.
A-docs
A-rustdoc-search
T-rustdoc
T-rustdoc-frontend
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
some of these, like tymethod, i don't even know what they do.
there's a list in the formal search syntax, but there's a lot of missing descriptions.
the "search tricks" inline help also seems to have an "exhaustive" list, but is actually missing a ton of kinds.
https://doc.rust-lang.org/nightly/rustdoc/read-documentation/search.html
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 with the rustdoc search documentation at the linked page, comparing the formal search syntax list with the “search tricks” inline help. Identify the missing kind descriptions and inconsistencies, then update both lists so the documented kinds and their explanations are complete and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100