Skip to content

Commit 07f603f

Browse files
committed
[docs] fixed GeoComResponse return code info in docstrings
1 parent 32a77d8 commit 07f603f

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

src/geocompy/geo/aut.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -207,13 +207,13 @@ def get_tolerance(self) -> GeoComResponse[tuple[Angle, Angle]]:
207207
Returns
208208
-------
209209
GeoComResponse
210-
Error codes:
211-
- ``NA``: GeoCOM Robotic license not found.
212-
213210
Params:
214211
- `Angle`: Horizontal tolerance.
215212
- `Angle`: Vertical tolerance.
216213
214+
Error codes:
215+
- ``NA``: GeoCOM Robotic license not found.
216+
217217
See Also
218218
--------
219219
set_tolerance
@@ -263,13 +263,13 @@ def get_timeout(self) -> GeoComResponse[tuple[float, float]]:
263263
Returns
264264
-------
265265
GeoComResponse
266-
Error codes:
267-
- ``NA``: GeoCOM Robotic license not found.
268-
269266
Params:
270267
- `float`: Horizontal timeout [sec].
271268
- `float`: Vertical timeout [sec].
272269
270+
Error codes:
271+
- ``NA``: GeoCOM Robotic license not found.
272+
273273
See Also
274274
--------
275275
set_timeout

src/geocompy/geo/bap.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,19 @@ def measure_distance_angle(
100100
- `Angle`: Vertical angle.
101101
- `float`: Slope distance.
102102
- `MEASUREPRG`: Actual distance mode.
103+
103104
Info codes:
104105
- ``TMC_ACCURACY_GUARANTEE``: Accuracy cannot be guaranteed.
105106
- ``TMC_ANGLE_ACCURACY_GUARANTEE``: Only angle measurement
106107
valid, accuracy cannot be guaranteed.
108+
107109
Warning codes:
108110
- ``TMC_ANGLE_NO_FULL_CORRECTION``: Only angle measurement
109111
valid, accuracy cannot be guaranteed.
110112
- ``TMC_ANGLE_OK``: Only angle measurement valid.
111113
- ``TMC_NO_FULL_CORRECTION``: Measurement without full
112114
correction.
115+
113116
Error codes:
114117
- ``AUT_ANGLE_ERROR``: Angle measurement error.
115118
- ``AUT_BAD_ENVIRONMENT``: Bad environmental conditions.

src/geocompy/geo/cam.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ def get_camera_position(
131131
Params:
132132
- `Coordinate`: Relative coordinates of the
133133
camera.
134+
134135
Error codes:
135136
- ``NA``: Imaging license not found.
136137
@@ -345,6 +346,7 @@ def get_overview_crosshair(self) -> GeoComResponse[tuple[float, float]]:
345346
image.
346347
- `float`: Vertical position of corsshair on
347348
image.
349+
348350
Error codes:
349351
- ``NA``: Imaging license not found.
350352

src/geocompy/geo/tmc.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,15 @@ def get_coordinate(
9595
coordinate.
9696
- `int`: Time of the coordinate
9797
acquisition.
98+
9899
Warning codes:
99100
- ``TMC_ACCURACY_GUARANTEE``: Accuracy is not guaranteed,
100101
because the measurement contains data with unverified
101102
accuracy. Coordinates are available.
102103
- ``TMC_NO_FULL_CORRECTION``: Results are not corrected by
103104
all sensors. Coordinates are available. Run check
104105
commands to determine the missing correction.
106+
105107
Error codes:
106108
- ``TMC_ANGLE_OK``: Angles are measured, but no valid
107109
distance was found.
@@ -606,6 +608,7 @@ def set_manual_distance(
606608
distance was found.
607609
- ``TMC_ANGLE_NO_ACC_GUARANTY``: Only angle measurement
608610
is valid, but the accuracy cannot be guaranteed.
611+
609612
Error codes:
610613
- ``TMC_DIST_ERROR``: Error is distance measurement,
611614
target not found. Repeat sighting and measurement!
@@ -784,6 +787,7 @@ def set_azimuth(
784787
distance was found.
785788
- ``TMC_ANGLE_NO_ACC_GUARANTY``: Only angle measurement
786789
is valid, but the accuracy cannot be guaranteed.
790+
787791
Error codes:
788792
- ``TMC_DIST_ERROR``: Error is distance measurement,
789793
target not found. Repeat sighting and measurement!
@@ -1327,6 +1331,7 @@ def get_simple_coordinate(
13271331
- ``TMC_NO_FULL_CORRECTION``: Results are not corrected by
13281332
all sensors. Coordinates are available. Run check
13291333
commands to determine the missing correction.
1334+
13301335
Error codes:
13311336
- ``TMC_ANGLE_OK``: Angles are measured, but no valid
13321337
distance was found.

0 commit comments

Comments
 (0)