-
Notifications
You must be signed in to change notification settings - Fork 150
docs(agents,style): Update agent guidance #3443
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ajf
wants to merge
2
commits into
NVIDIA:main
Choose a base branch
from
ajf:for-review/ajf/doc-fixes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+80
−15
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -695,3 +695,74 @@ fn prefer() { | |
| fails().ok(); | ||
| } | ||
| ``` | ||
|
|
||
| ### Avoid stringly-typed values | ||
|
|
||
| When a value has a known, finite set of possibilities, model it with an enum | ||
| (or a struct of enums) and implement traits `Display` and `FromStr` — do not | ||
| pass it around as a bare `String` or `&str` literal. Stringly-typed values are | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| easy to misspell (`NICO-` vs `NICOO-`), silently break log filters and alerts, | ||
| and can't be exhaustively checked by the compiler. See | ||
| [`ErrorCode`](crates/api-model/src/errors.rs) for the pattern: typed | ||
| `ErrorSystem`/`ErrorSubsystem` parts plus a `code`, rendered to the wire string | ||
| in one place. Reserve raw strings for genuinely open-ended values. | ||
|
|
||
| ### Prefer methods over free functions | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you for this. |
||
|
|
||
| When a function operates primarily on a specific type, define it as a method on that type rather than a free-standing function. This keeps related behavior co-located with the type, makes it easier to discover via autocomplete, and reads more naturally at the call site. | ||
|
|
||
| ```rust | ||
| // Avoid — free function that operates on a specific type | ||
| fn machine_display_name(machine: &Machine) -> String { | ||
| format!("{} ({})", machine.hostname, machine.id) | ||
| } | ||
|
|
||
| fn is_machine_ready(machine: &Machine) -> bool { | ||
| machine.state == MachineState::Ready && machine.health.is_ok() | ||
| } | ||
|
|
||
| // Prefer — methods on the type itself | ||
| impl Machine { | ||
| fn display_name(&self) -> String { | ||
| format!("{} ({})", self.hostname, self.id) | ||
| } | ||
|
|
||
| fn is_ready(&self) -> bool { | ||
| self.state == MachineState::Ready && self.health.is_ok() | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This applies to enums as well: | ||
|
|
||
| ```rust | ||
| // Avoid | ||
| fn is_terminal_state(state: &MachineState) -> bool { | ||
| matches!(state, MachineState::Failed | MachineState::Decommissioned) | ||
| } | ||
|
|
||
| fn state_label(state: &MachineState) -> &'static str { | ||
| match state { | ||
| MachineState::Ready => "ready", | ||
| MachineState::Failed => "failed", | ||
| MachineState::Decommissioned => "decommissioned", | ||
| } | ||
| } | ||
|
|
||
| // Prefer | ||
| impl MachineState { | ||
| fn is_terminal(&self) -> bool { | ||
| matches!(self, Self::Failed | Self::Decommissioned) | ||
| } | ||
|
|
||
| fn label(&self) -> &'static str { | ||
| match self { | ||
| Self::Ready => "ready", | ||
| Self::Failed => "failed", | ||
| Self::Decommissioned => "decommissioned", | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Free functions are still appropriate when the logic genuinely spans multiple unrelated types, belongs in a module rather than a single type, or is a utility with no natural owner. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.