oxidecomputer / oxidecomputer/hubris

Document the meaning of "defected"

Open
#16 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.6k
Forks
239
Avg merge
1d 12h
Merged PRs (30d)
23

Description

https://github.com/oxidecomputer/hubris/blob/b3b29b53d603a39bff59f9228399323b137721ac/abi/src/lib.rs#L261-L262

Describing what "defected" means in the documentation would be helpful.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked lines in abi/src/lib.rs, then read the surrounding documentation to understand how "defected" is used. Update the documentation to explain its meaning, and confirm that the explanation matches the surrounding ABI definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.