From a5e6c4800fb6eab435607d4ab1c597306fc237db Mon Sep 17 00:00:00 2001
From: Jesse Mapel <jmapel@usgs.gov>
Date: Tue, 16 Jun 2020 14:32:50 -0700
Subject: [PATCH] Updated Python doc config (#359)
---
ale/drivers/lro_drivers.py | 16 ++++++++++------
docs/source/library/python/base.rst | 2 +-
docs/source/library/python/cassini_driver.rst | 4 ++--
docs/source/library/python/lro_driver.rst | 2 +-
docs/source/library/python/mdis_driver.rst | 4 ++--
docs/source/library/python/mro_driver.rst | 4 ++--
docs/source/library/python/util.rst | 2 +-
7 files changed, 19 insertions(+), 15 deletions(-)
diff --git a/ale/drivers/lro_drivers.py b/ale/drivers/lro_drivers.py
index 0f412f9..cd2eaeb 100644
--- a/ale/drivers/lro_drivers.py
+++ b/ale/drivers/lro_drivers.py
@@ -153,6 +153,8 @@ class LroLrocPds3LabelNaifSpiceDriver(LineScanner, NaifSpice, Pds3Label, Driver)
The starting ephemeris time for LRO is computed by taking the
LRO:SPACECRAFT_CLOCK_PREROLL_COUNT, as defined in the label, and
adding offsets that were taken from an IAK.
+
+ Returns
-------
: double
Starting ephemeris time of the image
@@ -374,6 +376,8 @@ class LroLrocIsisLabelNaifSpiceDriver(LineScanner, NaifSpice, IsisLabel, Driver)
The starting ephemeris time for LRO is computed by taking the
LRO:SPACECRAFT_CLOCK_PREROLL_COUNT, as defined in the label, and
adding offsets that were taken from an IAK.
+
+ Returns
-------
: double
Starting ephemeris time of the image
@@ -525,7 +529,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
@property
def wavelength(self):
"""
- Returns the wavelength in meters used for image acquistion.
+ Returns the wavelength in meters used for image acquistion.
Returns
-------
@@ -548,7 +552,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
: double
scaled pixel width
"""
- return self.label['IsisCube']['Instrument']['ScaledPixelHeight'];
+ return self.label['IsisCube']['Instrument']['ScaledPixelHeight'];
# Default line_exposure_duration assumes that time is given in milliseconds and coverts
@@ -556,7 +560,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
@property
def line_exposure_duration(self):
"""
- Line exposure duration in seconds. The sum of the burst and the delay for the return.
+ Line exposure duration in seconds. The sum of the burst and the delay for the return.
Returns
-------
@@ -579,7 +583,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
range_coefficients_orig = self.label['IsisCube']['Instrument']['RangeCoefficientSet']
# The first elt of each list is time, which we handle separately in range_conversion_time
- range_coefficients = [elt[1:] for elt in range_coefficients_orig]
+ range_coefficients = [elt[1:] for elt in range_coefficients_orig]
return range_coefficients
@property
@@ -600,7 +604,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
@property
def ephemeris_start_time(self):
"""
- Returns the start and stop ephemeris times for the image.
+ Returns the start and stop ephemeris times for the image.
Returns
-------
@@ -612,7 +616,7 @@ class LroMiniRfIsisLabelNaifSpiceDriver(Radar, NaifSpice, IsisLabel, Driver):
@property
def ephemeris_stop_time(self):
"""
- Returns the stop ephemeris times for the image.
+ Returns the stop ephemeris times for the image.
Returns
-------
diff --git a/docs/source/library/python/base.rst b/docs/source/library/python/base.rst
index d40200f..c921b7b 100644
--- a/docs/source/library/python/base.rst
+++ b/docs/source/library/python/base.rst
@@ -5,7 +5,7 @@ The :mod:`ale.drivers.base` module
.. versionadded:: 0.1.0
-.. automodule:: ale.drivers.base
+.. automodule:: ale.base.base
:synopsis:
:members:
:show-inheritance:
diff --git a/docs/source/library/python/cassini_driver.rst b/docs/source/library/python/cassini_driver.rst
index 635a1f9..6f68250 100644
--- a/docs/source/library/python/cassini_driver.rst
+++ b/docs/source/library/python/cassini_driver.rst
@@ -1,11 +1,11 @@
:mod:`cassini_driver` --- Cassini Driver Classes
================================================
-The :mod:`ale.drivers.cassini_driver` module
+The :mod:`ale.drivers.co_drivers` module
.. versionadded:: 0.1.0
-.. automodule:: ale.drivers.cassini_driver
+.. automodule:: ale.drivers.co_drivers
:synopsis:
:members:
:show-inheritance:
diff --git a/docs/source/library/python/lro_driver.rst b/docs/source/library/python/lro_driver.rst
index 506d7af..6657b02 100644
--- a/docs/source/library/python/lro_driver.rst
+++ b/docs/source/library/python/lro_driver.rst
@@ -5,7 +5,7 @@ The :mod:`ale.drivers.lro_driver` module
.. versionadded:: 0.1.0
-.. automodule:: ale.drivers.lro_driver
+.. automodule:: ale.drivers.lro_drivers
:synopsis:
:members:
:show-inheritance:
diff --git a/docs/source/library/python/mdis_driver.rst b/docs/source/library/python/mdis_driver.rst
index 12a96a1..f6c0a96 100644
--- a/docs/source/library/python/mdis_driver.rst
+++ b/docs/source/library/python/mdis_driver.rst
@@ -1,11 +1,11 @@
:mod:`mdis_driver` --- MDIS Driver Classes
============================================
-The :mod:`ale.drivers.mdis_driver` module
+The :mod:`ale.drivers.mess_drivers` module
.. versionadded:: 0.1.0
-.. automodule:: ale.drivers.mdis_driver
+.. automodule:: ale.drivers.mess_drivers
:synopsis:
:members:
:show-inheritance:
diff --git a/docs/source/library/python/mro_driver.rst b/docs/source/library/python/mro_driver.rst
index 5a0165c..e29fab5 100644
--- a/docs/source/library/python/mro_driver.rst
+++ b/docs/source/library/python/mro_driver.rst
@@ -1,11 +1,11 @@
:mod:`mro_driver` --- MRO Driver Classes
============================================
-The :mod:`ale.drivers.mro_driver` module
+The :mod:`ale.drivers.mro_drivers` module
.. versionadded:: 0.1.0
-.. automodule:: ale.drivers.mro_driver
+.. automodule:: ale.drivers.mro_drivers
:synopsis:
:members:
:show-inheritance:
diff --git a/docs/source/library/python/util.rst b/docs/source/library/python/util.rst
index 375ceb2..64cdd02 100644
--- a/docs/source/library/python/util.rst
+++ b/docs/source/library/python/util.rst
@@ -1,7 +1,7 @@
:mod:`util` --- General Utilities
============================================
-The :mod:`ale.drivers` module
+The :mod:`ale.util` module
.. versionadded:: 0.1.0
--
GitLab