improve documentation

aburrell · Nov 30, 2015 · 65d46fd · 65d46fd
1 parent db0c9f6
commit 65d46fd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/apexpy/apex.py b/src/apexpy/apex.py
@@ -641,6 +641,7 @@ def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
         '''Returns quasi-dipole base vectors f1 and f2 at the specified coordinates.
 
         The vectors are described by Richmond [1995] [2]_ and Emmert et al. [2010] [3]_.
+        The vector components are geodetic east and north.
 
         Parameters
         ==========
@@ -696,6 +697,8 @@ def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
         '''Returns base vectors in quasi-dipole and apex coordinates.
 
         The vectors are described by Richmond [1995] [4]_ and Emmert et al. [2010] [5]_.
+        The vector components are geodetic east, north, and up (only east and
+        north for `f1` and `f2`).
 
         Parameters
         ==========