Skip to content

Commit

Permalink
Docstring improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
bgottula committed Apr 5, 2023
1 parent ceed9ae commit f403b97
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 5 deletions.
3 changes: 2 additions & 1 deletion track/align.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ def __init__(
encoder_positions: MountEncoderPositions,
mount: TelescopeMount,
):
"""
"""Construct a Position object.
Args:
encoder_positions: Mount encoder positions corresponding to this sky position
mount: Instance of TelescopeMount
Expand Down
3 changes: 2 additions & 1 deletion track/align_guidescope.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/env python3

"""
"""Perform guidescope alignment.
Run a procedure to estimate the angular offset between the guidescope camera and the main telescope
camera. If this is completed successfully the estimated offset is saved with the active mount
alignment model. The goal is to eliminate the need for ultra-precise physical alignment of the
Expand Down
3 changes: 2 additions & 1 deletion track/bootstrap.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/env python3

"""
"""Get ready to track objects.
Does all of the following:
1. Alignment.
Expand Down
5 changes: 3 additions & 2 deletions track/ser.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
"""SER file support.
The SER file format is popular in astrophotography for storage of RAW images or video. It is
described on this website: http://www.grischa-hahn.homepage.t-online.de/astro/ser/. This class
described on this website: http://www.grischa-hahn.homepage.t-online.de/astro/ser/. This module
implements version 3 which is documented here:
http://www.grischa-hahn.homepage.t-online.de/astro/ser/SER%20Doc%20V3b.pdf
"""
Expand Down
1 change: 1 addition & 0 deletions track/targets.py
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,7 @@ def __init__(
camera. The output of the integrator is the estimate of the blind target bias.
bias_mag_limit: The magnitude of the blind target bias estimate is limited to this
value to prevent it from growing excessively large.
telem_logger: Telemetry points will be logged if a logger instance is provided.
spiral_search: Do a spiral search until a target is found in the camera.
"""
self.blind_target = blind_target
Expand Down

0 comments on commit f403b97

Please sign in to comment.