shorten doc

vijayvarma392 · Oct 14, 2023 · 3aa771b · 3aa771b
1 parent db8735a
commit 3aa771b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 25 deletions.
diff --git a/gw_eccentricity/eccDefinition.py b/gw_eccentricity/eccDefinition.py
@@ -243,20 +243,21 @@ def __init__(self, dataDict, num_orbits_to_exclude_before_merger=2,
                 extrema are not found. This can happen for various reasons
                 including when the eccentricity is too small for some methods
                 (like the Amplitude method) to measure. See e.g. Fig.4 of
-                arxiv.2302.11257. If no extrema are found but the following two
-                conditions are met:
+                arxiv.2302.11257. If no extrema are found, we check whether the
+                following two conditions are satisfied.
 
                 1. `set_failures_to_zero` is set to `True`.
-                2. The length of the waveform is required to be at least (5 +
-                `num_obrits_to_exclude_before_merger`) orbits long. By default,
-                `num_obrits_to_exclude_before_merger` is set to 2, meaning that
-                2 orbits are removed from the waveform before it is used by the
-                extrema finding routine. Consequently, in the default
-                configuration, the original waveform in the input `dataDict`
-                must have a minimum length of 7 orbits.
-
-                we assume that small eccentricity is the cause, and set the
-                returned eccentricity and mean anomaly to zero.
+                2. The waveform is at least
+                  (5 + `num_obrits_to_exclude_before_merger`) orbits long. By
+                  default, `num_obrits_to_exclude_before_merger` is set to 2,
+                  meaning that 2 orbits are removed from the waveform before it
+                  is used by the extrema finding routine. Consequently, in the
+                  default configuration, the original waveform in the input
+                  `dataDict` must have a minimum length of 7 orbits.
+
+                If both of these conditions are met, we assume that small
+                eccentricity is the cause, and set the returned eccentricity
+                and mean anomaly to zero.
                 USE THIS WITH CAUTION!
         """
         # Get data necessary for eccentricity measurement

diff --git a/gw_eccentricity/gw_eccentricity.py b/gw_eccentricity/gw_eccentricity.py
@@ -365,21 +365,22 @@ def measure_eccentricity(tref_in=None,
             extrema are not found. This can happen for various reasons
             including when the eccentricity is too small for some methods (like
             the Amplitude method) to measure. See e.g. Fig.4 of
-            arxiv.2302.11257. If no extrema are found but the following two
-            conditions are met:
+            arxiv.2302.11257. If no extrema are found, we check whether the
+            following two conditions are satisfied.
 
             1. `set_failures_to_zero` is set to `True`.
-            2. The length of the waveform is required to be at least (5 +
-            `num_obrits_to_exclude_before_merger`) orbits long. By default,
-            `num_obrits_to_exclude_before_merger` is set to 2, meaning that 2
-            orbits are removed from the waveform before it is used by the
-            extrema finding routine. Consequently, in the default
-            configuration, the original waveform in the input `dataDict` must
-            have a minimum length of 7 orbits.
-
-            we assume that small eccentricity is the cause, and set the
-            returned eccentricity and mean anomaly to zero.  USE THIS WITH
-            CAUTION!
+            2. The waveform is at least (5 +
+              `num_obrits_to_exclude_before_merger`) orbits long. By default,
+              `num_obrits_to_exclude_before_merger` is set to 2, meaning that 2
+              orbits are removed from the waveform before it is used by the
+              extrema finding routine. Consequently, in the default
+              configuration, the original waveform in the input `dataDict` must
+              have a minimum length of 7 orbits.
+
+            If both of these conditions are met, we assume that small
+            eccentricity is the cause, and set the returned eccentricity and
+            mean anomaly to zero.
+            USE THIS WITH CAUTION!
 
     Returns
     -------