mirror/astronomy
1
0
Fork 0
mirror of https://github.com/cosinekitty/astronomy.git synced 2026-05-19 06:17:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Miscellaneous documentation fixes.

Browse Source 
While working on the Kotlin implementation, I have
found a few documentation mistakes in the other language
implementations. These have been accumulating in the
`kotlin` branch. I migrated these changes back into
the released code for now, because I don't want to wait
until Kotlin is ready.
This commit is contained in:
Don Cross
2022-04-02 16:52:54 -04:00
parent 608a7a8dca
commit 9d6294d7fe
22 changed files with 361 additions and 465 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
source/python/README.md
View File

@@ -339,7 +339,7 @@ When reporting a solar eclipse observed at a specific location on the Earth
(a "local" solar eclipse), a series of events occur. In addition
to the time of each event, it is important to know the altitude of the Sun,
because each event may be invisible to the observer if the Sun is below
the horizon (i.e. it at night).
the horizon.
If `altitude` is negative, the event is theoretical only; it would be
visible if the Earth were transparent, but the observer cannot actually see it.
If `altitude` is positive but less than a few degrees, visibility will be impaired by
@@ -411,8 +411,6 @@ equator projected onto the sky.
Returned by [`SearchGlobalSolarEclipse`](#SearchGlobalSolarEclipse) or [`NextGlobalSolarEclipse`](#NextGlobalSolarEclipse)
to report information about a solar eclipse event.
Field `peak` holds the date and time of the peak of the eclipse, defined as
the instant when the axis of the Moon's shadow cone passes closest to the Earth's center.
The eclipse is classified as partial, annular, or total, depending on the
maximum amount of the Sun's disc obscured, as seen at the peak location
on the surface of the Earth.
@@ -431,7 +429,7 @@ not be used.
| Type | Attribute | Description |
| --- | --- | --- |
| [`EclipseKind`](#EclipseKind) | `kind` | The type of solar eclipse: `EclipseKind.Partial`, `EclipseKind.Annular`, or `EclipseKind.Total`. |
| [`Time`](#Time) | `peak` | The date and time of the eclipse at its peak. |
| [`Time`](#Time) | `peak` | The date and time when the solar eclipse is darkest. This is the instant when the axis of the Moon's shadow cone passes closest to the Earth's center. |
| `float` | `distance` | The distance between the Sun/Moon shadow axis and the center of the Earth, in kilometers. |
| `float` | `latitude` | The geographic latitude at the center of the peak eclipse shadow. |
| `float` | `longitude` | The geographic longitude at the center of the peak eclipse shadow. |
@@ -576,7 +574,7 @@ See [`EclipseEvent`](#EclipseEvent) for more information.
Returned by [`SearchLunarEclipse`](#SearchLunarEclipse) or [`NextLunarEclipse`](#NextLunarEclipse)
to report information about a lunar eclipse event.
When a lunar eclipse is found, it is classified as penumbral, partial, or total.
Penumbral eclipses are difficult to observe, because the moon is only slightly dimmed
Penumbral eclipses are difficult to observe, because the Moon is only slightly dimmed
by the Earth's penumbra; no part of the Moon touches the Earth's umbra.
Partial eclipses occur when part, but not all, of the Moon touches the Earth's umbra.
Total eclipses occur when the entire Moon passes into the Earth's umbra.
@@ -1617,7 +1615,7 @@ the rings appear edge-on, and are thus nearly invisible from the Earth. The `rin
**Calculates the inverse of an atmospheric refraction angle.**
Given an observed altitude angle that includes atmospheric refraction,
calculate the negative angular correction to obtain the unrefracted
calculates the negative angular correction to obtain the unrefracted
altitude. This is useful for cases where observed horizontal
coordinates are to be converted to another orientation system,
but refraction first must be removed from the observed position.
@@ -1640,7 +1638,7 @@ This will be less than or equal to zero.
**Calculates the inverse of a rotation matrix.**
Given a rotation matrix that performs some coordinate transform,
this function returns the matrix that reverses that trasnform.
this function returns the matrix that reverses that transform.
| Type | Parameter | Description |
| --- | --- | --- |
@@ -2455,7 +2453,7 @@ Target: EQJ = equatorial system, using equator at the J2000 epoch.
| [`Observer`](#Observer) | `observer` | A location near the Earth's mean sea level that define's the observer's horizon. |
### Returns: [`RotationMatrix`](#RotationMatrix)
A rotation matrix that converts HOR to EQD at `time` and for `observer`.
A rotation matrix that converts HOR to EQJ at `time` and for `observer`.
---

16
source/python/astronomy/astronomy.py
View File

@@ -5080,7 +5080,7 @@ def InverseRefractionAngle(refraction, bent_altitude):
"""Calculates the inverse of an atmospheric refraction angle.
Given an observed altitude angle that includes atmospheric refraction,
calculate the negative angular correction to obtain the unrefracted
calculates the negative angular correction to obtain the unrefracted
altitude. This is useful for cases where observed horizontal
coordinates are to be converted to another orientation system,
but refraction first must be removed from the observed position.
@@ -6995,7 +6995,7 @@ def InverseRotation(rotation):
"""Calculates the inverse of a rotation matrix.
Given a rotation matrix that performs some coordinate transform,
this function returns the matrix that reverses that trasnform.
this function returns the matrix that reverses that transform.
Parameters
----------
@@ -7376,7 +7376,7 @@ def Rotation_HOR_EQJ(time, observer):
Returns
-------
RotationMatrix
A rotation matrix that converts HOR to EQD at `time` and for `observer`.
A rotation matrix that converts HOR to EQJ at `time` and for `observer`.
"""
hor_eqd = Rotation_HOR_EQD(time, observer)
eqd_eqj = Rotation_EQD_EQJ(time)
@@ -8272,7 +8272,7 @@ class LunarEclipseInfo:
Returned by #SearchLunarEclipse or #NextLunarEclipse
to report information about a lunar eclipse event.
When a lunar eclipse is found, it is classified as penumbral, partial, or total.
Penumbral eclipses are difficult to observe, because the moon is only slightly dimmed
Penumbral eclipses are difficult to observe, because the Moon is only slightly dimmed
by the Earth's penumbra; no part of the Moon touches the Earth's umbra.
Partial eclipses occur when part, but not all, of the Moon touches the Earth's umbra.
Total eclipses occur when the entire Moon passes into the Earth's umbra.
@@ -8324,9 +8324,6 @@ class GlobalSolarEclipseInfo:
Returned by #SearchGlobalSolarEclipse or #NextGlobalSolarEclipse
to report information about a solar eclipse event.
Field `peak` holds the date and time of the peak of the eclipse, defined as
the instant when the axis of the Moon's shadow cone passes closest to the Earth's center.
The eclipse is classified as partial, annular, or total, depending on the
maximum amount of the Sun's disc obscured, as seen at the peak location
on the surface of the Earth.
@@ -8349,7 +8346,8 @@ class GlobalSolarEclipseInfo:
kind : EclipseKind
The type of solar eclipse: `EclipseKind.Partial`, `EclipseKind.Annular`, or `EclipseKind.Total`.
peak : Time
The date and time of the eclipse at its peak.
The date and time when the solar eclipse is darkest.
This is the instant when the axis of the Moon's shadow cone passes closest to the Earth's center.
distance : float
The distance between the Sun/Moon shadow axis and the center of the Earth, in kilometers.
latitude : float
@@ -8381,7 +8379,7 @@ class EclipseEvent:
(a "local" solar eclipse), a series of events occur. In addition
to the time of each event, it is important to know the altitude of the Sun,
because each event may be invisible to the observer if the Sun is below
the horizon (i.e. it at night).
the horizon.
If `altitude` is negative, the event is theoretical only; it would be
visible if the Earth were transparent, but the observer cannot actually see it.