oxidecomputer / oxidecomputer/omicron
Nexus: Polish error copy around when to include parents in API selectors
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
repo search for "should not be specified"
It's a small thing, but I want to clean up the grammar, punctuation, clarity, and consistency on these errors that are very easy to run into when first learning how to use the API. There are a bunch. Here are just a few:
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 repository search for "should not be specified", then inspect the referenced error strings in nexus/src/app/internet_gateway.rs and nexus/src/app/disk.rs. Review the other matches for consistent grammar, punctuation, clarity, and wording around parent selectors; done means the affected API errors follow the same polished style.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100