Skip to content

Commit

Permalink
📚 Update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ronisbr committed Dec 16, 2023
1 parent 6075043 commit ec9fe75
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/src/man/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ is the type of the coefficients in the model.
## API Functions

```julia
function coefficients(model::AbstractGravityModel{T}, degree::Int, order::Int, time::DataTime) where T<:Number -> T, T
function coefficients(model::AbstractGravityModel{T}, degree::Int, order::Int, time::DataTime = DateTime("2000-01-01")) where T<:Number -> T, T
```

This function must return the coefficients `Clm` and `Slm` of the gravity `model` for the
specified `degree`, `order`, and `time`. Hence:
specified `degree`, `order`, and `time`. If the latter argument is omitted, the J2000.0
epoch is used. Hence:

```julia
coefficients(model, 10, 8, DateTime("2023-06-19"))
Expand All @@ -27,7 +28,8 @@ must return a `Tuple{T, T}` with the `Clm` and `Slm`, respectively, for the degr

> **Note**
> If the model has constant coefficients, the function must still accept the positional
> argument `time`, but it will be neglected.
> argument `time`, but it will be neglected. The package already defines the function
> without the `time` for the sake of usage simplification.
---

Expand Down

0 comments on commit ec9fe75

Please sign in to comment.