Wording of the doc

Signed-off-by: Cédric Foellmi <cedric@onekiloparsec.dev>
onekiloparsec · Nov 1, 2023 · e05f8bd · e05f8bd
1 parent dd7d054
commit e05f8bd
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 24 deletions.
diff --git a/src/planets/jupiter/elliptical.ts b/src/planets/jupiter/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/mars/elliptical.ts b/src/planets/mars/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/mercury/elliptical.ts b/src/planets/mercury/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/neptune/elliptical.ts b/src/planets/neptune/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/pluto/elliptical.ts b/src/planets/pluto/elliptical.ts
@@ -7,7 +7,7 @@ import { getEclipticLatitude, getEclipticLongitude, getRadiusVector } from './co
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -19,7 +19,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -31,7 +31,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/saturn/elliptical.ts b/src/planets/saturn/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/uranus/elliptical.ts b/src/planets/uranus/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates

diff --git a/src/planets/venus/elliptical.ts b/src/planets/venus/elliptical.ts
@@ -23,7 +23,7 @@ import { getEccentricity, getSemiMajorAxis } from './orbital'
 
 /**
  * Geocentric distance (distance between the planet and Earth's center).
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -35,7 +35,7 @@ export function getGeocentricDistance (jd: JulianDay | number): AstronomicalUnit
 
 /**
  * Geocentric apparent ecliptic coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion).
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration.
  * @see getEclipticCoordinates
  * @see getGeocentricEquatorialCoordinates
  * @param {JulianDay} jd The julian day
@@ -47,7 +47,7 @@ export function getGeocentricEclipticCoordinates (jd: JulianDay | number): Eclip
 
 /**
  * Geocentric apparent equatorial coordinates
- * It takes into account the effects of aberration (light-time travel & Earth motion) and Earth nutation
+ * It takes into account the effects of light-time travel & Earth nutation and annual aberration
  * (through the use of True Obliquity of Ecliptic at the time of JD).
  * @see getEquatorialCoordinates
  * @see getGeocentricEclipticCoordinates