[api] Fix some doc comments - #11196
Merged
Merged
Conversation
- Fix silo_user_list/silo_user_view summaries that wrongly said "built-in (system) users" (#9359) - Say "network interface" instead of "OPTE" in jumbo frames doc comments - Clarify that audit log start_time/end_time filter on time_completed (redo of #9871 on main) - Add missing doc comment on SiloCreate.discoverable and reword the matching Silo view comment (#4942)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #9359, closes #4942, closes #7649, and redoes #9871.
silo_user_listandsilo_user_viewsaid "built-in (system) users", but they are for regular silo users ([api] Wrong description onsilo_user_listandsilo_user_view#9359)start_timeandend_timeparams filter ontime_completed(redo of docs: clarify audit log filtering behavior. #9871)SiloCreate.discoverableand reword the matching one on theSiloview (Missing description underdiscoverableinSiloCreate#4942)AffinityPolicyvariant docs to avoid the ambiguous "affinity request": constraints apply when an instance starts, and withfailthe start request errors and the instance remains stopped (Clarify "affinity request" in policy doc comment #7649)Also say "network interface" instead of "OPTE" in the jumbo frames doc comments — noticed in the discussion on oxidecomputer/oxide.rs#1525, where the OPTE wording had been copied into the CLI. "Primary network interface" is accurate: the jumbo MTU is applied only to the primary NIC's OPTE port, and only when both the fleet flag and the instance bit are set.
omicron/nexus/src/app/instance.rs
Lines 2923 to 2935 in bc1e632