RSDK-11708 Improved validate docstring to explain more clearly #5268
Conversation
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
dhritinaidu
requested review from
a team,
njooma and
lia-viam
and removed request for
a team
viambot
added
the
safe to test
njooma
approved these changes
Sep 23, 2025
| // 3. An error if any Config fields are missing or invalid. | ||
| // | ||
| // The `path` parameter indicates | ||
| // where this resource appears in the robot's JSON configuration |
There was a problem hiding this comment.
Suggested change
| // where this resource appears in the robot's JSON configuration | |
| // where this resource appears in the machine's JSON configuration |
| // 3. An error if any Config fields are missing or invalid. | ||
| // | ||
| // The `path` parameter indicates | ||
| // where this resource appears in the robot's JSON configuration |
There was a problem hiding this comment.
Suggested change
| // where this resource appears in the robot's JSON configuration | |
| // where this resource appears in the machine's JSON configuration |
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.
Dug into where in the runtime validate is called. Docstring now explains what the path parameter is and what the return values are more clearly.