Skip to content

Commit 9625eb7

Browse files
committed
Apply suggestions from code review
1 parent 54f7c42 commit 9625eb7

File tree

2 files changed

+9
-21
lines changed

2 files changed

+9
-21
lines changed

lib/src/components/arm/arm.dart

-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ abstract class Arm extends Resource {
1111
/// Get the current [Pose] of the end of the arm.
1212
///
1313
/// ```
14-
/// // Get the pose of an arm named "myArm2"
1514
/// final currentPose = await myArm.endPosition();
1615
/// ```
1716
///

lib/src/components/servo/servo.dart

+9-20
Original file line numberDiff line numberDiff line change
@@ -15,50 +15,39 @@ abstract class Servo extends Resource {
1515

1616
/// Get the current angle (degrees) of the [Servo].
1717
///
18-
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
19-
///
2018
/// ```
2119
/// var angle = await myServo.position();
2220
/// ```
23-
Future<int> position({Map<String, dynamic>? extra});
24-
25-
/// Stop the [Servo]. It is assumed that the servo stops immediately.
26-
///
27-
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
28-
///
29-
Future<void> stop({Map<String, dynamic>? extra});
30-
31-
/// Get if the [Servo] is currently moving.
3221
///
3322
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
34-
Future<bool> isMoving();
23+
Future<int> position({Map<String, dynamic>? extra});
3524

36-
/// Get the [ResourceName] for this [Servo] with the given [name]
37-
///
38-
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
25+
/// Stop the [Servo]. It is assumed that the servo stops immediately.
3926
///
4027
/// ```
4128
/// await myServo.stop();
4229
/// ```
43-
Future<void> stop({Map<String, dynamic>? extra});
44-
45-
/// Whether the [Servo] is currently moving.
4630
///
4731
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
32+
Future<void> stop({Map<String, dynamic>? extra});
33+
34+
/// Get if the [Servo] is currently moving.
4835
///
4936
/// ```
5037
/// var isItMoving = await myServo.isMoving();
5138
/// ```
39+
///
40+
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
5241
Future<bool> isMoving();
5342

5443
/// Get the [ResourceName] for this [Servo] with the given [name].
5544
///
56-
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
57-
///
5845
/// ```
5946
/// // Example:
6047
/// var name = Servo.getResourceName('myServo');
6148
/// ```
49+
///
50+
/// For more information, see [Servo component](https://docs.viam.com/components/servo/).
6251
static ResourceName getResourceName(String name) {
6352
return Servo.subtype.getResourceName(name);
6453
}

0 commit comments

Comments
 (0)