Skip to content

Commit fae11da

Browse files
authored
Add back gantry return descriptions (#533)
1 parent 687b8da commit fae11da

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/components/gantry/gantry.ts

+4
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ export interface Gantry extends Resource {
5656
* // Get the current positions of the axes in millimeters
5757
* const positions = await gantry.getPosition();
5858
* ```
59+
*
60+
* @returns A list of the current position of each axis in millimeters.
5961
*/
6062
getPosition: (extra?: Struct) => Promise<number[]>;
6163

@@ -88,6 +90,8 @@ export interface Gantry extends Resource {
8890
* // Get the lengths of the axes in millimeters
8991
* const lengths = await gantry.getLengths();
9092
* ```
93+
*
94+
* @returns A list of the length of each axis in millimeters.
9195
*/
9296
getLengths: (extra?: Struct) => Promise<number[]>;
9397

0 commit comments

Comments
 (0)