changes in docstrings

Author: Alvaro Arroyo Parejo

ESANEOCC/core.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Main module from ESA NEOCCS library. This module contains the two main
+Main module from ESA NEOCC library. This module contains the two main
 methods of the library: *query_list* and *query_object*. The information
 is obtained from ESA Near-Earth Object Coordination Centre's (NEOCC) web
 portal: https://neo.ssa.esa.int/.
@@ -61,7 +61,7 @@ def query_list(list_name):
         * Risk list (special): *risk_list_special*
         * Close approaches (upcoming): *close_approaches_upcoming*
         * Close approaches (recent): *close_approaches_recent*
-        * Priotiry list (normal): *priority_list*
+        * Priority list (normal): *priority_list*
         * Priority list (faint): *priority_list_faint*
         * Close encounter list: *close_encounter*
         * Impacted objects: *impacted_objects*
@@ -199,7 +199,7 @@ def query_object(name, tab, **kwargs):
         name : str
             Name of the requested object
         tab : str
-            Name of the request tab. Valid names are:summary,
+            Name of the request tab. Valid names are: summary,
             orbit_properties, physical_properties, observations,
             ephemerides, close_approaches and impacts.
         **kwargs : str
@@ -291,7 +291,7 @@ def query_object(name, tab, **kwargs):
             -sigimp: The lateral distance in sigma-space from the LOV to
             the Earth surface. A zero implies that the LOV passes through
             the Earth-dist: Minimum Distance in Earth radii. The lateral
-            distance from the LOV to the center of the Earth
+            distance from the LOV to the centre of the Earth
             -width: one-sigma semi-width of the Target Plane confidence
             region in Earth radii
             -stretch: Stretching factor. It indicates how much the
@@ -393,7 +393,7 @@ def query_object(name, tab, **kwargs):
         information, it is necessary to provide two additional inputs to
         *query_object* method: **orbital_elements** and **orbit_epoch**.
 
-        It is mandatory to write these two paramters as: *orbit_epoch=' '*
+        It is mandatory to write these two parameters as: *orbit_epoch=' '*
         to make the library works.
 
         >>> ast_orbit_prop = neocc.query_object(name='99942',
@@ -415,7 +415,7 @@ def query_object(name, tab, **kwargs):
         method: **observatory**, **start**, **stop**, **step** and
         **step_unit***.
 
-        It is mandatory to write these five paramters as: *observatory=' '*
+        It is mandatory to write these five parameters as: *observatory=' '*
         to make the library works.
 
         >>> ast_ephemerides = neocc.query_object(name='99942',

ESANEOCC/lists.py

@@ -24,7 +24,7 @@
                          list.
 1.3        16-06-2021    URL and Timeout from configuration file
                          for astroquery implementation.\n
-                         Change dateformat to datetime isoformat
+                         Change dateformat to datetime ISO format
 ========   ===========   ==========================================
 
 © Copyright [European Space Agency][2021]

ESANEOCC/tabs.py

@@ -31,7 +31,7 @@
                          Adding timeout of 90 seconds.
 1.3        16-06-2021    URLs and timeout from configuration file for
                          astroquery implementation.\n
-                         Change time format to datetime isoformat.\n
+                         Change time format to datetime ISO format.\n
                          Change to correct types in attributes (e.g.,
                          matrices, etc.)\n
                          Change ephemerides skyfooter to fix bug.\n
@@ -1517,13 +1517,14 @@ def _orb_prop_parser(self, data_obj):
 
 
 class KeplerianOrbitProperties(OrbitProperties):
-    """This class contains information of keplerian asteroid orbit
-    properties. This class inherits the attributes from OrbitProperties.
+    """This class contains information of asteroid orbit
+    properties in Keplerian reference frame. This class inherits the attributes
+    from OrbitProperties.
 
     Attributes
     ----------
     kep : pandas.DataFrame
-        Data frame which contains the keplerian elements information.
+        Data frame which contains the Keplerian elements information.
     perihelion : int
         Orbit perihelion in au.
     aphelion : int
@@ -1543,11 +1544,11 @@ class KeplerianOrbitProperties(OrbitProperties):
     u_par : int
         Uncertainty parameter as defined by MPC.
     rms : pandas.DataFrame
-        Root mean square for keplerian elements
+        Root mean square for Keplerian elements
     cov : pandas.DataFrame
-        Covariance matrix for keplerian elements
+        Covariance matrix for Keplerian elements
     cor : pandas.DataFrame
-        Correlation matrix for keplerian elements
+        Correlation matrix for Keplerian elements
 
     """
 
@@ -1678,8 +1679,9 @@ def _orb_kep_prop_parser(self, data_obj):
 
 
 class EquinoctialOrbitProperties(OrbitProperties):
-    """This class contains information of equinoctial asteroid orbit
-    properties. This class inherits the attributes from OrbitProperties.
+    """This class contains information of asteroid orbit
+    properties in equinoctial reference frame. This class inherits
+    the attributes from OrbitProperties.
 
     Attributes
     ----------
@@ -1842,7 +1844,7 @@ class Ephemerides:
         Time step and time unit used during ephemerides calculation.
     ephemerides : pandas.DataFrame
         Data frame which contains the information of the object
-        ephemerides
+        ephemerides.
 
     """
 
@@ -1916,9 +1918,9 @@ def _ephem_parser(self, name, observatory, start, stop, step, step_unit):
             stop : str
                 End date from which ephemerides are obtained.
             step : str
-                Value for the time step (e.g. '1', '0.1', etc.)
+                Value for the time step (e.g. '1', '0.1', etc.).
             step_unit : str
-                Units of the time step
+                Units of the time step.
             Raises
             ------
             KeyError