Skip to content

Commit 3544a53

Browse files
committed
Fixed data module doc comments
1 parent 6df4168 commit 3544a53

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

src/geocompy/data.py

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -936,20 +936,20 @@ class Coordinate(Vector):
936936

937937
class POSITION(Enum):
938938
"""Positioning mode."""
939-
NORMAL = 0 # : Fast
940-
PRECISE = 1 # : Precise
939+
NORMAL = 0 #: Fast
940+
PRECISE = 1 #: Precise
941941

942942

943943
class ADJUST(Enum):
944944
"""ATR adjustment tolerance mode."""
945-
NORMAL = 0 # : Angle tolerance.
946-
POINT = 1 # : Point tolerance.
945+
NORMAL = 0 #: Angle tolerance.
946+
POINT = 1 #: Point tolerance.
947947

948948

949949
class ATR(Enum):
950950
"""ATR mode."""
951-
POSITION = 0 # : Position to angles.
952-
TARGET = 1 # : Position to target near angles.
951+
POSITION = 0 #: Position to angles.
952+
TARGET = 1 #: Position to target near angles.
953953

954954

955955
class TURN(Enum):
@@ -959,13 +959,13 @@ class TURN(Enum):
959959

960960

961961
class MEASUREPROGRAM(Enum):
962-
NOMEASURE = 0 # : No measurement, take last value.
963-
NODISTANCE = 1 # : No distance measurement, angles only.
964-
DISTANCE = 2 # : Default distance measurement.
965-
TRACK = 3 # : Tracking distance measurement.
966-
RAPIDTRACK = 4 # : Rapid tracking distance measurement.
967-
CLEAR = 5 # : Clear distances.
968-
STOPTRACK = 6 # : Stop tracking.
962+
NOMEASURE = 0 #: No measurement, take last value.
963+
NODISTANCE = 1 #: No distance measurement, angles only.
964+
DISTANCE = 2 #: Default distance measurement.
965+
TRACK = 3 #: Tracking distance measurement.
966+
RAPIDTRACK = 4 #: Rapid tracking distance measurement.
967+
CLEAR = 5 #: Clear distances.
968+
STOPTRACK = 6 #: Stop tracking.
969969

970970

971971
class SHUTDOWN(Enum):
@@ -976,8 +976,8 @@ class SHUTDOWN(Enum):
976976

977977
class STARTUP(Enum):
978978
"""Instrument startup mode."""
979-
LOCAL = 0 # : Manual mode.
980-
REMOTE = 1 # : GeoCom mode.
979+
LOCAL = 0 #: Manual mode.
980+
REMOTE = 1 #: GeoCom mode.
981981

982982

983983
class DEVICECLASS(Enum):
@@ -1013,66 +1013,66 @@ class TRACKLIGHT(Enum):
10131013

10141014
class ATRLOCK(Enum):
10151015
"""ATR lock status."""
1016-
NONE = 0 # : Disabled
1017-
LOCK = 1 # : Enabled
1016+
NONE = 0 #: Disabled
1017+
LOCK = 1 #: Enabled
10181018
PREDICT = 2
10191019

10201020

10211021
class STOP(Enum):
10221022
"""Servo motor stopping mode."""
1023-
NORMAL = 0 # : Slow down with current acceleration.
1024-
CUTOFF = 1 # : Slow down by motor power termination.
1023+
NORMAL = 0 #: Slow down with current acceleration.
1024+
CUTOFF = 1 #: Slow down by motor power termination.
10251025

10261026

10271027
class CONTROLLER(Enum):
10281028
"""Motor controller operation mode."""
1029-
POSITIONING = 0 # : Relative positioning.
1030-
MOVE = 1 # : Constant speed.
1031-
MANUAL = 2 # : Manual positioning.
1032-
LOCK = 3 # : Lock-in controller.
1033-
BREAK = 4 # : Break controller.
1029+
POSITIONING = 0 #: Relative positioning.
1030+
MOVE = 1 #: Constant speed.
1031+
MANUAL = 2 #: Manual positioning.
1032+
LOCK = 3 #: Lock-in controller.
1033+
BREAK = 4 #: Break controller.
10341034
# 5, 6 do not use (why?)
1035-
TERMINATE = 7 # : Terminate current task.
1035+
TERMINATE = 7 #: Terminate current task.
10361036

10371037

10381038
class AUTOPOWER(Enum):
10391039
"""Automatic power off mode."""
1040-
DISABLED = 0 # : Automatic poweroff disabled.
1041-
SLEEP = 1 # : Put instument into sleep mode.
1042-
SHUTDOWN = 2 # : Poweroff instrument.
1040+
DISABLED = 0 #: Automatic poweroff disabled.
1041+
SLEEP = 1 #: Put instument into sleep mode.
1042+
SHUTDOWN = 2 #: Poweroff instrument.
10431043

10441044

10451045
class INCLINATION(Enum):
10461046
"""Inclination calculation mode."""
1047-
MEASURE = 0 # : Measure inclination.
1048-
AUTO = 1 # : Automatic inclination handling.
1049-
PLANE = 2 # : Model inclination from previous measurements.
1047+
MEASURE = 0 #: Measure inclination.
1048+
AUTO = 1 #: Automatic inclination handling.
1049+
PLANE = 2 #: Model inclination from previous measurements.
10501050

10511051

10521052
class MEASUREMENT(Enum):
1053-
STOP = 0 # : Stop measurement program.
1054-
DISTANCE = 1 # : Default distance measurement.
1055-
TRACK = 2 # : Track distance.
1056-
CLEAR = 3 # : Clear current measurement data.
1057-
SIGNAL = 4 # : Signal intensity measurement.
1058-
RAPIDTRACK = 8 # : Rapid track distance.
1053+
STOP = 0 #: Stop measurement program.
1054+
DISTANCE = 1 #: Default distance measurement.
1055+
TRACK = 2 #: Track distance.
1056+
CLEAR = 3 #: Clear current measurement data.
1057+
SIGNAL = 4 #: Signal intensity measurement.
1058+
RAPIDTRACK = 8 #: Rapid track distance.
10591059

10601060

10611061
class EDMMODE(Enum):
10621062
"""Distance measurement mode."""
1063-
SINGLE_STANDARD = 0, # : Standard single measurement.
1064-
SINGLE_EXACT = 1, # : Exact single measurement.
1065-
SINGLE_FAST = 2, # : Fast single measurement.
1066-
CONT_STANDARD = 3, # : Repeated measurement.
1067-
CONT_EXACT = 4, # : Repeated average measurement.
1068-
CONT_FAST = 5, # : Fast repeated measurement.
1069-
UNDEFINED = 6 # : Not defined.
1063+
SINGLE_STANDARD = 0, #: Standard single measurement.
1064+
SINGLE_EXACT = 1, #: Exact single measurement.
1065+
SINGLE_FAST = 2, #: Fast single measurement.
1066+
CONT_STANDARD = 3, #: Repeated measurement.
1067+
CONT_EXACT = 4, #: Repeated average measurement.
1068+
CONT_FAST = 5, #: Fast repeated measurement.
1069+
UNDEFINED = 6 #: Not defined.
10701070

10711071

10721072
class FACE(Enum):
10731073
"""Instrument view face."""
1074-
F1 = 0 # : Face left.
1075-
F2 = 1 # : Face right.
1074+
F1 = 0 #: Face left.
1075+
F2 = 1 #: Face right.
10761076

10771077

10781078
class FORMAT(Enum):

0 commit comments

Comments
 (0)