Skip to content
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

DOCS-2400: Add snippets for resource base methods #231

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

JessamyT
Copy link
Contributor

No description provided.

@JessamyT JessamyT requested a review from a team as a code owner June 13, 2024 00:23
@JessamyT JessamyT requested review from stuqdog and lia-viam June 13, 2024 00:23
Comment on lines +29 to +33
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```

Should these actually not be here since they're not part of the API?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be considerations I'm not thinking of but it seems harmless and more thorough to include these.

Comment on lines +40 to +44
///
/// ```
/// // Example, getting the ResourceName of a sensor named "my_sensor":
/// var resourceName = Sensor.getResourceName('my_sensor');
/// ```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
///
/// ```
/// // Example, getting the ResourceName of a sensor named "my_sensor":
/// var resourceName = Sensor.getResourceName('my_sensor');
/// ```

Comment on lines +29 to +33
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be considerations I'm not thinking of but it seems harmless and more thorough to include these.

@JessamyT JessamyT merged commit e5a7063 into viamrobotics:main Jun 14, 2024
3 checks passed
@JessamyT JessamyT deleted the 2400resourcebase branch June 14, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants