dosctring shite

exoplanet-dev · Nov 27, 2018 · 994d751 · 994d751
1 parent ba011e0
commit 994d751
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 37 deletions.
diff --git a/exoplanet/estimators.py b/exoplanet/estimators.py
@@ -46,8 +46,8 @@ def estimate_minimum_mass(periods, x, y, yerr=None, t0s=None, m_star=1):
             if not an AstroPy Quantity.
 
     Returns:
-        msini: An estimate of the minimum mass of each planet as an AstroPy
-            Quantity with units of ``M_jupiter``.
+        An estimate of the minimum mass of each planet as an AstroPy Quantity
+        with units of ``M_jupiter``.
 
     """
     if yerr is None:
@@ -157,7 +157,7 @@ def autocorr_function(x):
         x: The series as a 1-D numpy array.
 
     Returns:
-        array: The autocorrelation function of the time series.
+        The autocorrelation function of the time series.
 
     """
     x = np.atleast_1d(x)

diff --git a/exoplanet/gp/terms.py b/exoplanet/gp/terms.py
@@ -234,8 +234,8 @@ class RealTerm(Term):
     care should be taken to ensure positivity.
 
     Args:
-        a or log_a: The lamplitude of the term.
-        c or log_c: The lexponent of the term.
+        tensor a or log_a: The amplitude of the term.
+        tensor c or log_c: The exponent of the term.
 
     """
 
@@ -264,10 +264,10 @@ class ComplexTerm(Term):
     if :math:`a_j\,c_j \ge b_j\,d_j`.
 
     Args:
-        a or log_a: The real part of amplitude.
-        b or log_b: The imaginary part of amplitude.
-        c or log_c: The real part of the exponent.
-        d or log_d: The imaginary part of exponent.
+        tensor a or log_a: The real part of amplitude.
+        tensor b or log_b: The imaginary part of amplitude.
+        tensor c or log_c: The real part of the exponent.
+        tensor d or log_d: The imaginary part of exponent.
 
     """
 
@@ -295,9 +295,9 @@ class SHOTerm(Term):
     with the parameters ``S0``, ``Q``, and ``w0``.
 
     Args:
-        S0 or log_S0: The parameter :math:`S_0`.
-        Q or log_Q: The parameter :math:`Q`.
-        w0 or log_w0: The parameter :math:`\omega_0`.
+        tensor S0 or log_S0: The parameter :math:`S_0`.
+        tensor Q or log_Q: The parameter :math:`Q`.
+        tensor w0 or log_w0: The parameter :math:`\omega_0`.
 
     """
 
@@ -362,8 +362,8 @@ class Matern32Term(Term):
         \exp\left(-\frac{\sqrt{3}\,\tau}{\rho}\right)
 
     Args:
-        sigma or log_sigma: The parameter :math:`\sigma`.
-        rho or log_rho: The parameter :math:`\rho`.
+        tensor sigma or log_sigma: The parameter :math:`\sigma`.
+        tensor rho or log_rho: The parameter :math:`\rho`.
         eps (Optional[float]): The value of the parameter :math:`\epsilon`.
             (default: `0.01`)
 
@@ -397,12 +397,12 @@ class RotationTerm(TermSum):
     stochastic variability in stellar time series from rotation to pulsations.
 
     Args:
-        amp or log_amp: The amplitude of the variability.
-        period or log_period: The primary period of variability.
-        Q0 or log_Q0: The quality factor (or really the quality factor minus
-            one half) for the secondary oscillation.
-        deltaQ or log_deltaQ: The difference between the quality factors of
-            the first and the second modes. This parameterization (if
+        tensor amp or log_amp: The amplitude of the variability.
+        tensor period or log_period: The primary period of variability.
+        tensor Q0 or log_Q0: The quality factor (or really the quality factor
+            minus one half) for the secondary oscillation.
+        tensor deltaQ or log_deltaQ: The difference between the quality factors
+            of the first and the second modes. This parameterization (if
             ``deltaQ > 0``) ensures that the primary mode alway has higher
             quality.
         mix: The fractional amplitude of the secondary mode compared to the

diff --git a/exoplanet/orbits/keplerian.py b/exoplanet/orbits/keplerian.py
@@ -221,8 +221,8 @@ def get_planet_position(self, t):
             t: The times where the position should be evaluated.
 
         Returns:
-            x, y, z: The components of the position vector at ``t`` in units
-                of ``R_sun``.
+            The components of the position vector at ``t`` in units of
+            ``R_sun``.
 
         """
         return tuple(tt.squeeze(x)
@@ -235,8 +235,8 @@ def get_star_position(self, t):
             t: The times where the position should be evaluated.
 
         Returns:
-            x, y, z: The components of the position vector at ``t`` in units
-                of ``R_sun``.
+            The components of the position vector at ``t`` in units of
+            ``R_sun``.
 
         """
         return tuple(tt.squeeze(x)
@@ -249,8 +249,8 @@ def get_relative_position(self, t):
             t: The times where the position should be evaluated.
 
         Returns:
-            x, y, z: The components of the position vector at ``t`` in units
-                of ``R_sun``.
+            The components of the position vector at ``t`` in units of
+            ``R_sun``.
 
         """
         star = self._get_position(self.a_star, t)
@@ -272,8 +272,8 @@ def get_planet_velocity(self, t):
             t: The times where the velocity should be evaluated.
 
         Returns:
-            vx, vy, vz: The components of the velocity vector at ``t`` in units
-                of ``M_sun/day``.
+            The components of the velocity vector at ``t`` in units of
+            ``M_sun/day``.
 
         """
         return tuple(tt.squeeze(x)
@@ -286,8 +286,8 @@ def get_star_velocity(self, t):
             t: The times where the velocity should be evaluated.
 
         Returns:
-            vx, vy, vz: The components of the velocity vector at ``t`` in units
-                of ``M_sun/day``.
+            The components of the velocity vector at ``t`` in units of
+            ``M_sun/day``.
 
         """
         return tuple(tt.squeeze(x)
@@ -302,8 +302,8 @@ def get_radial_velocity(self, t, output_units=None):
                 the output will be evaluated in ``m/s``.
 
         Returns:
-            vrad: The radial velocity evaluated at ``t`` in units of
-                ``output_units``.
+            The radial velocity evaluated at ``t`` in units of
+            ``output_units``.
 
         """
         if output_units is None:
@@ -325,8 +325,7 @@ def approx_in_transit(self, t, r=0.0, texp=None, duration_factor=3):
                 large planets or very eccentric orbits.
 
         Returns:
-            inds (vector): The indices of the timestamps that are expected to
-                be in transit.
+            The indices of the timestamps that are expected to be in transit.
 
         """
         # Estimate the maximum duration of the transit using the equations

diff --git a/exoplanet/orbits/simple.py b/exoplanet/orbits/simple.py
@@ -49,8 +49,8 @@ def get_relative_position(self, t):
             t: The times where the position should be evaluated.
 
         Returns:
-            x, y, z: The components of the position vector at ``t`` in units
-                of ``R_sun``.
+            The components of the position vector at ``t`` in units of
+            ``R_sun``.
 
         """
         dt = tt.mod(tt.shape_padright(t) - self._ref_time, self.period)
@@ -80,7 +80,7 @@ def approx_in_transit(self, t, r=None, texp=None, duration_factor=None):
             texp (Optional[float]): The exposure time.
 
         Returns:
-            inds (vector): The indices of the timestamps that are in transit.
+            The indices of the timestamps that are in transit.
 
         """
         dt = tt.mod(tt.shape_padright(t) - self._ref_time, self.period)