oxidecomputer / oxidecomputer/progenitor
improve documentation examples
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 136
- Avg merge
- 8h 36m
- Merged PRs (30d)
- 14
Description
Examples currently list that the input to .body() should be ... a variable named body. We should expand that (in the builder case) to be something like
// ...
.body(OperationIdBodyType::builder()
.field1(xxx)
.field2(yyy)
)
.send()
.await;
Also:
For dropshot-paginated operations, we should generate an example that shows the use of the streaming interface (i.e. ending in .stream().collect::<Result<Vec<_>>>().await rather than .send().await)
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
Locate the code that generates documentation examples for .body() and dropshot-paginated operations. Update the examples to show a builder-based body value and a streaming call ending in collection, then verify the generated examples contain both forms.
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
- 45/100