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

C: Fixed documentation mistake.

Browse Source
This commit is contained in:
Don Cross
2020-05-26 21:18:50 -04:00
parent 9645ff6cc3
commit 3c5de6b4f9
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
generate/template/astronomy.c
View File

@@ -5710,7 +5710,7 @@ static double ShadowSemiDurationMinutes(astro_time_t center_time, double radius_
* See #astro_lunar_eclipse_t for more information.
* To find a series of lunar eclipses, call this function once,
* then keep calling #Astronomy_NextLunarEclipse as many times as desired,
* passing in the `center` value returned from the previous call.
* passing in the `peak` value returned from the previous call.
*
* @param startTime
* The date and time for starting the search for a lunar eclipse.
@@ -6385,7 +6385,7 @@ astro_local_solar_eclipse_t Astronomy_SearchLocalSolarEclipse(
*
* After using #Astronomy_SearchLocalSolarEclipse to find the first solar eclipse
* in a series, you can call this function to find the next consecutive solar eclipse.
* Pass in the `center` value from the #astro_local_solar_eclipse_t returned by the
* Pass in the `peak` value from the #astro_local_solar_eclipse_t returned by the
* previous call to `Astronomy_SearchLocalSolarEclipse` or `Astronomy_NextLocalSolarEclipse`
* to find the next solar eclipse.
*

4
source/c/README.md
View File

@@ -918,7 +918,7 @@ After using [`Astronomy_SearchGlobalSolarEclipse`](#Astronomy_SearchGlobalSolarE
After using [`Astronomy_SearchLocalSolarEclipse`](#Astronomy_SearchLocalSolarEclipse) to find the first solar eclipse in a series, you can call this function to find the next consecutive solar eclipse. Pass in the `center` value from the [`astro_local_solar_eclipse_t`](#astro_local_solar_eclipse_t) returned by the previous call to `Astronomy_SearchLocalSolarEclipse` or `Astronomy_NextLocalSolarEclipse` to find the next solar eclipse.
After using [`Astronomy_SearchLocalSolarEclipse`](#Astronomy_SearchLocalSolarEclipse) to find the first solar eclipse in a series, you can call this function to find the next consecutive solar eclipse. Pass in the `peak` value from the [`astro_local_solar_eclipse_t`](#astro_local_solar_eclipse_t) returned by the previous call to `Astronomy_SearchLocalSolarEclipse` or `Astronomy_NextLocalSolarEclipse` to find the next solar eclipse.
@@ -1528,7 +1528,7 @@ To iterate through consecutive alternating perigee and apogee events, call `Astr
This function finds the first lunar eclipse that occurs after `startTime`. A lunar eclipse found may be penumbral, partial, or total. See [`astro_lunar_eclipse_t`](#astro_lunar_eclipse_t) for more information. To find a series of lunar eclipses, call this function once, then keep calling [`Astronomy_NextLunarEclipse`](#Astronomy_NextLunarEclipse) as many times as desired, passing in the `center` value returned from the previous call.
This function finds the first lunar eclipse that occurs after `startTime`. A lunar eclipse found may be penumbral, partial, or total. See [`astro_lunar_eclipse_t`](#astro_lunar_eclipse_t) for more information. To find a series of lunar eclipses, call this function once, then keep calling [`Astronomy_NextLunarEclipse`](#Astronomy_NextLunarEclipse) as many times as desired, passing in the `peak` value returned from the previous call.

4
source/c/astronomy.c
View File

@@ -7365,7 +7365,7 @@ static double ShadowSemiDurationMinutes(astro_time_t center_time, double radius_
* See #astro_lunar_eclipse_t for more information.
* To find a series of lunar eclipses, call this function once,
* then keep calling #Astronomy_NextLunarEclipse as many times as desired,
* passing in the `center` value returned from the previous call.
* passing in the `peak` value returned from the previous call.
*
* @param startTime
* The date and time for starting the search for a lunar eclipse.
@@ -8040,7 +8040,7 @@ astro_local_solar_eclipse_t Astronomy_SearchLocalSolarEclipse(
*
* After using #Astronomy_SearchLocalSolarEclipse to find the first solar eclipse
* in a series, you can call this function to find the next consecutive solar eclipse.
* Pass in the `center` value from the #astro_local_solar_eclipse_t returned by the
* Pass in the `peak` value from the #astro_local_solar_eclipse_t returned by the
* previous call to `Astronomy_SearchLocalSolarEclipse` or `Astronomy_NextLocalSolarEclipse`
* to find the next solar eclipse.
*