DOCS-2035: Add example snippets to movement sensor, power sensor, sensor #230
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
purplenicole730
approved these changes
Jun 17, 2024
| @@ -18,31 +18,72 @@ abstract class MovementSensor extends Resource { | |||
| static const Subtype subtype = Subtype(resourceNamespaceRDK, resourceTypeComponent, 'movement_sensor'); | |||
|
|
|||
| /// Obtain the measurements/data specific to this [MovementSensor] | |||
| /// If a sensor is not configured to have a measurement or fails to read a piece of data, it will not appear in the readings dictionary. | |||
| /// If a sensor is not configured to have a measurement or fails to read a piece of data, | |||
There was a problem hiding this comment.
nit: comment seems long compared to others
| Future<Position> position({Map<String, dynamic>? extra}); | ||
|
|
||
| /// Get the current linear velocity as a [Vector3] with x, y, and z axes represented in mm/sec | ||
| /// Get the current linear velocity as a [Vector3] with x, y, and z axes represented in mm/sec. |
There was a problem hiding this comment.
nit: comment is long compared to others
njooma
approved these changes
Jun 17, 2024
|
@purplenicole730 Ooh I was unaware of this standardization. I personally don't see a problem with some comments being longer than others, since some methods require more explanation and some are highly self-explanatory. I'd like to leave those as they are if that's okay? |
|
@JessamyT |
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.
No description provided.