oxidecomputer / oxidecomputer/openapi-lint
rust-documentation: cannot compose with progenitor generated types
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 12
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
When progenitor generates types, it adds a <details> JSON goes here </details> blob in the top-level structure or enum comment. That JSON blob trips the rust-documentation lint, seemingly due to having square brackets not followed by parens, preventing composition with downstream APIs whose structures are generated by progenitor.
A workaround for this is to use replace in the progenitor generate_api! macro to prevent these generated comments from coming into play.
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 reproducing the rust-documentation lint failure with types generated by progenitor, focusing on the JSON blob in top-level structure and enum comments. Review the progenitor generate_api! macro and its replace workaround. Done means generated documentation no longer triggers the square-bracket lint and downstream API composition works without that workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100