diff --git a/source/c/README.md b/source/c/README.md index 0ab981b2..cea9699a 100644 --- a/source/c/README.md +++ b/source/c/README.md @@ -4602,7 +4602,7 @@ The [`astro_time_t`](#astro_time_t) type contains `ut` to represent Universal Ti Both `tt` and `ut` are necessary for performing different astronomical calculations. Indeed, certain calculations (such as rise/set times) require both time scales. See the documentation for the `ut` and `tt` fields for more detailed information. -In cases where `[`astro_time_t`](#astro_time_t)` is included in a structure returned by a function that can fail, the `astro_status_t` field `status` will contain a value other than `ASTRO_SUCCESS`; in that case the `ut` and `tt` will hold `NAN` (not a number). In general, when there is an error code stored in a struct field `status`, the caller should ignore all other values in that structure, including the `ut` and `tt` inside `[`astro_time_t`](#astro_time_t)`. +In cases where [`astro_time_t`](#astro_time_t) is included in a structure returned by a function that can fail, the [`astro_status_t`](#astro_status_t) field `status` will contain a value other than `ASTRO_SUCCESS`; in that case the `ut` and `tt` will hold `NAN` (not a number). In general, when there is an error code stored in a struct field `status`, the caller should ignore all other values in that structure, including the `ut` and `tt` inside `[`astro_time_t`](#astro_time_t)`. | Type | Member | Description | | ---- | ------ | ----------- | @@ -4730,6 +4730,6 @@ The function [`Astronomy_CorrectLightTravel`](#Astronomy_CorrectLightTravel) sol The function [`Astronomy_Search`](#Astronomy_Search) numerically solves for the time that a given event occurs. An event is defined as the time when an arbitrary function transitions between having a negative value and a non-negative value. This transition is called an *ascending root*. -The type astro_search_func_t represents such a callback function that accepts a custom `context` pointer and an [`astro_time_t`](#astro_time_t) representing the time to probe. The function returns an [`astro_func_result_t`](#astro_func_result_t) that contains either a real number in `value` or an error code in `status` that aborts the search. +The type [`astro_search_func_t`](#astro_search_func_t) represents such a callback function that accepts a custom `context` pointer and an [`astro_time_t`](#astro_time_t) representing the time to probe. The function returns an [`astro_func_result_t`](#astro_func_result_t) that contains either a real number in `value` or an error code in `status` that aborts the search. -The `context` points to some data whose type varies depending on the callback function. It can contain any auxiliary parameters (other than time) needed to evaluate the function. For example, a function may pertain to a specific celestial body, in which case `context` may point to a value of type astro_body_t. The `context` parameter is supplied by the caller of [`Astronomy_Search`](#Astronomy_Search), which passes it along to every call to the callback function. If the caller of `Astronomy_Search` knows that the callback function does not need a context, it is safe to pass `NULL` as the context pointer. \ No newline at end of file +The `context` points to some data whose type varies depending on the callback function. It can contain any auxiliary parameters (other than time) needed to evaluate the function. For example, a function may pertain to a specific celestial body, in which case `context` may point to a value of type [`astro_body_t`](#astro_body_t). The `context` parameter is supplied by the caller of [`Astronomy_Search`](#Astronomy_Search), which passes it along to every call to the callback function. If the caller of `Astronomy_Search` knows that the callback function does not need a context, it is safe to pass `NULL` as the context pointer. \ No newline at end of file diff --git a/source/c/astronomy.h b/source/c/astronomy.h index fcdda6e8..5a327dfb 100644 --- a/source/c/astronomy.h +++ b/source/c/astronomy.h @@ -289,8 +289,8 @@ astro_status_t; * Indeed, certain calculations (such as rise/set times) require both time scales. * See the documentation for the `ut` and `tt` fields for more detailed information. * - * In cases where `astro_time_t` is included in a structure returned by - * a function that can fail, the `astro_status_t` field `status` will contain a value + * In cases where astro_time_t is included in a structure returned by + * a function that can fail, the #astro_status_t field `status` will contain a value * other than `ASTRO_SUCCESS`; in that case the `ut` and `tt` will hold `NAN` (not a number). * In general, when there is an error code stored in a struct field `status`, the * caller should ignore all other values in that structure, including the `ut` and `tt` @@ -613,7 +613,7 @@ astro_func_result_t; * An event is defined as the time when an arbitrary function transitions between having * a negative value and a non-negative value. This transition is called an *ascending root*. * - * The type astro_search_func_t represents such a callback function that accepts a + * The type #astro_search_func_t represents such a callback function that accepts a * custom `context` pointer and an astro_time_t representing the time to probe. * The function returns an astro_func_result_t that contains either a real * number in `value` or an error code in `status` that aborts the search. @@ -621,7 +621,7 @@ astro_func_result_t; * The `context` points to some data whose type varies depending on the callback function. * It can contain any auxiliary parameters (other than time) needed to evaluate the function. * For example, a function may pertain to a specific celestial body, in which case `context` - * may point to a value of type astro_body_t. The `context` parameter is supplied by + * may point to a value of type #astro_body_t. The `context` parameter is supplied by * the caller of #Astronomy_Search, which passes it along to every call to the callback function. * If the caller of `Astronomy_Search` knows that the callback function does not need a context, * it is safe to pass `NULL` as the context pointer.