oxidecomputer / oxidecomputer/omicron
Consistent "get" or "fetch" in endpoint descriptions
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
We use "fetch" in some spots, "get" in others. I thought we used fetch more, but that may not be true. Fetch feels more precise and technical, but it also is two characters longer for little benefit. I'll have to see how they each feel in context in the docs site to decide.
Thanks for the suggestions, I'll reword these. I notice that "get" and "fetch" are used pretty interchangeably in other APIs...we should probably give that a pass to make it more consistent (separately from this PR of course):
Originally posted by @hawkw in https://github.com/oxidecomputer/omicron/pull/7277#discussion_r1995969384
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
The issue names no file, test, or concrete endpoint. Start by locating the endpoint descriptions in the docs site and inventorying their uses of "get" and "fetch"; the work is done when the terminology is consistent according to the chosen convention.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100