[nexus] [minor] Bring BGP endpoint doc comments in line with conventions #4329
Conversation
This file contains 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
david-crespo
commented
Oct 24, 2023
| @@ -2609,7 +2609,7 @@ async fn networking_loopback_address_delete( | |||
| apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await | |||
| } | |||
|
|
|||
| /// Get loopback addresses, optionally filtering by id | |||
| /// List loopback addresses | |||
There was a problem hiding this comment.
Didn't think "optionally filtering by id" is necessary, also not sure it's even true
There was a problem hiding this comment.
Yeah, good catch. That's a remnant of an earlier version.
rcgoodfellow
approved these changes
Oct 24, 2023
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.
I noticed there were periods in the docs sidebar. Also used the word "list" as appropriate.