DOCS-2347: Standardize code samples #4002
Closed
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
viambot
added
the
safe to test
|
Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!
|
andf-viam
reviewed
May 24, 2024
| type Readings struct { | ||
| Name resource.Name | ||
| Readings map[string]interface{} | ||
| } | ||
|
|
||
| // A Service centralizes all sensors into one place. | ||
| // |
There was a problem hiding this comment.
This is looking great! I'll give this a full read-through Monday, but caught this: This code sample for Readings should precede the description to Service + a newline. Currently it will appear as part of the Service method description.
|
This ticket ended up being resolved in DOCS-2316. Safe to close this, thanks for your work on this Sky --> it helped me write mine. |
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.
Changed the format of the code samples (whitespace, comments, punctuation) and deleted any resource initializations for uniformity across samples.
Method descriptions have been lightly modified.
The meaning has been retained (in my opinion, this is probably subjective!).