oxidecomputer / oxidecomputer/ingot
Want to forward `#[doc]` attributes to generated items
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Currently, generated items are largely undocumented. We need to forward field-level documentation to associated setters and getters in traits.
This is particularly necessary when keeping track of which headers do/do not account for their own size in length fields, and/or track length in multiples of 4/8B chunks.
Contributor guide
No contributing guide indexed for this repository
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 locating the code generator for traits and generated setters and getters, then trace how field-level #[doc] attributes are handled. Confirm that documentation for fields appears on the associated generated methods, including the header length details described in the issue; add or update coverage if the repository provides generator tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100