Trait impl list should indicate and link to impl items when additional documentation is available
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
For example on the trait Sum page the impl<T, U> Sum<Option<U>> for Option<T> shows no documentation or indication that additional documentation is available.
Compare to the same impl on the Option struct page which has a method with doc comments.
Implementations can specify additional behavior that goes beyond what is promised by the trait itself, which can be important to know that such additional documentation exists.
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
Compare the linked Sum trait page with the linked Option page, focusing on how the impl list exposes additional documentation. Find the rustdoc entry point and relevant tests for rendering impl lists, then make the trait-page entry indicate and link to available impl documentation; the two pages should provide consistent discoverability.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100