-
Notifications
You must be signed in to change notification settings - Fork 24
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
Conversation
/// | ||
/// ``` | ||
/// // Example, creating a Sensor from a resource named "mySensor": | ||
/// var mySensor = Sensor.fromResourceName('mySensor'); | ||
/// ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// | |
/// ``` | |
/// // 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?
There was a problem hiding this comment.
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.
/// | ||
/// ``` | ||
/// // Example, getting the ResourceName of a sensor named "my_sensor": | ||
/// var resourceName = Sensor.getResourceName('my_sensor'); | ||
/// ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// | |
/// ``` | |
/// // Example, getting the ResourceName of a sensor named "my_sensor": | |
/// var resourceName = Sensor.getResourceName('my_sensor'); | |
/// ``` |
/// | ||
/// ``` | ||
/// // Example, creating a Sensor from a resource named "mySensor": | ||
/// var mySensor = Sensor.fromResourceName('mySensor'); | ||
/// ``` |
There was a problem hiding this comment.
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.
No description provided.