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

Fixed two documentation formatting mistakes.

Browse Source
This commit is contained in:
Don Cross
2020-06-14 16:49:02 -04:00
parent e2cb68e021
commit 2f13b463f1
6 changed files with 7 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
source/python/README.md
View File

@@ -603,18 +603,13 @@ information about a transit of Mercury or Venus.
A transit is when Mercury or Venus passes between the Sun and Earth so that
the other planet is seen in silhouette against the Sun.
The calculations are performed from the point of view of a geocentric observer.
peak : Time
When the planet is most aligned with the Sun, as seen from the Earth.
finish : Time
The date and time at the end of the transit.
This is the moment the planet is last seen against the Sun in its background.
separation : float
The minimum angular separation, in arcminutes, between the centers of the Sun and the planet.
This angle pertains to the time stored in `peak`.
| Type | Attribute | Description |
| --- | --- | --- |
| [`Time`](#Time) | `start` | The date and time at the beginning of the transit. This is the moment the planet first becomes visible against the Sun in its background. |
| [`Time`](#Time) | `peak` | When the planet is most aligned with the Sun, as seen from the Earth. |
| [`Time`](#Time) | `finish` | The date and time at the end of the transit. This is the moment the planet is last seen against the Sun in its background. |
| `float` | `separation` | The minimum angular separation, in arcminutes, between the centers of the Sun and the planet. This angle pertains to the time stored in `peak`. |
---

3
source/python/astronomy.py
View File

@@ -7313,14 +7313,11 @@ class TransitInfo:
start : Time
The date and time at the beginning of the transit.
This is the moment the planet first becomes visible against the Sun in its background.
peak : Time
When the planet is most aligned with the Sun, as seen from the Earth.
finish : Time
The date and time at the end of the transit.
This is the moment the planet is last seen against the Sun in its background.
separation : float
The minimum angular separation, in arcminutes, between the centers of the Sun and the planet.
This angle pertains to the time stored in `peak`.