From 2f13b463f1434b2dbb97bd34681280d1588ac4d3 Mon Sep 17 00:00:00 2001 From: Don Cross Date: Sun, 14 Jun 2020 16:49:02 -0400 Subject: [PATCH] Fixed two documentation formatting mistakes. --- generate/template/astronomy.js | 2 +- generate/template/astronomy.py | 3 --- source/js/README.md | 4 ++-- source/js/astronomy.js | 2 +- source/python/README.md | 11 +++-------- source/python/astronomy.py | 3 --- 6 files changed, 7 insertions(+), 18 deletions(-) diff --git a/generate/template/astronomy.js b/generate/template/astronomy.js index e2bd383d..1e2465ab 100644 --- a/generate/template/astronomy.js +++ b/generate/template/astronomy.js @@ -5053,7 +5053,7 @@ function PlanetTransitBoundary(body, planet_radius_km, t1, t2, direction) { * @param {string} body * The planet whose transit is to be found. Must be `"Mercury"` or `"Venus"`. * - * @param {Astronomy.AstroTime} + * @param {Astronomy.AstroTime} startTime * The date and time for starting the search for a transit. * * @returns {Astronomy.TransitInfo} diff --git a/generate/template/astronomy.py b/generate/template/astronomy.py index e00d91cc..da84f8f0 100644 --- a/generate/template/astronomy.py +++ b/generate/template/astronomy.py @@ -4843,14 +4843,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`. diff --git a/source/js/README.md b/source/js/README.md index 8d5a095f..96f61c2c 100644 --- a/source/js/README.md +++ b/source/js/README.md @@ -1992,7 +1992,7 @@ See [LocalSolarEclipseInfo](#Astronomy.LocalSolarEclipseInfo) for more informati -### Astronomy.SearchTransit(body, The) ⇒ [TransitInfo](#Astronomy.TransitInfo) +### Astronomy.SearchTransit(body, startTime) ⇒ [TransitInfo](#Astronomy.TransitInfo) **Kind**: static method of [Astronomy](#Astronomy) **Brief**: Searches for the first transit of Mercury or Venus after a given date. @@ -2005,7 +2005,7 @@ To continue the search, pass the `finish` time in the returned structure to | Param | Type | Description | | --- | --- | --- | | body | string | The planet whose transit is to be found. Must be `"Mercury"` or `"Venus"`. | -| The | [AstroTime](#Astronomy.AstroTime) | date and time for starting the search for a transit. | +| startTime | [AstroTime](#Astronomy.AstroTime) | The date and time for starting the search for a transit. | * * * diff --git a/source/js/astronomy.js b/source/js/astronomy.js index b8ff99ba..1a61647a 100644 --- a/source/js/astronomy.js +++ b/source/js/astronomy.js @@ -6483,7 +6483,7 @@ function PlanetTransitBoundary(body, planet_radius_km, t1, t2, direction) { * @param {string} body * The planet whose transit is to be found. Must be `"Mercury"` or `"Venus"`. * - * @param {Astronomy.AstroTime} + * @param {Astronomy.AstroTime} startTime * The date and time for starting the search for a transit. * * @returns {Astronomy.TransitInfo} diff --git a/source/python/README.md b/source/python/README.md index 219b9e32..7b990a0d 100644 --- a/source/python/README.md +++ b/source/python/README.md @@ -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`. | --- diff --git a/source/python/astronomy.py b/source/python/astronomy.py index 5dbd737b..ebf55702 100644 --- a/source/python/astronomy.py +++ b/source/python/astronomy.py @@ -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`.