Skip to content

Commit

Permalink
📚 Improve docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ronisbr committed Jul 2, 2024
1 parent e104969 commit 6f1ee91
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/api/Propagators.jl
Original file line number Diff line number Diff line change
Expand Up @@ -289,21 +289,25 @@ function propagate!(
end

"""
propagate_to_epoch(::Val{:propagator}, jd::Number, args...; kwargs...)
propagate_to_epoch(::Val{:propagator}, dt::DateTime, args...; kwargs...)
propagate_to_epoch(::Val{:propagator}, jd::Number, args...; kwargs...) -> SVector{3, T}, SVector{3, T}, OrbitPropagator{Tepoch, T}
propagate_to_epoch(::Val{:propagator}, dt::DateTime, args...; kwargs...) -> SVector{3, T}, SVector{3, T}, OrbitPropagator{Tepoch, T}
Initialize the orbit `propagator` and propagate the orbit until the epoch defined by either
the Julian Day `jd` [UTC] or by a `DateTime` object `dt` [UTC] from the initial orbit epoch.
The initialization arguments `args...` and `kwargs...` are the same as in the initialization
function [`Propagators.init`](@ref).
!!! note
`T` is the propagator number type. For more information, see [`Propagators.init`](@ref).
# Returns
- `SVector{3, T}`: Position vector [m] represented in the inertial frame at propagation
instant.
- `SVector{3, T}`: Velocity vector [m / s] represented in the inertial frame at propagation
instant.
- [`OrbitPropagator`](@ref): Structure with the initialized parameters.
- [`OrbitPropagator{Tepoch, T}`](@ref): Structure with the initialized parameters.
"""
function propagate_to_epoch(T::Val, dt::DateTime, args...; kwargs...)
jd = datetime2julian(dt)
Expand Down Expand Up @@ -341,7 +345,7 @@ the initialization function [`Propagators.init`](@ref).
instant.
- `SVector{3, T}`: Velocity vector [m / s] represented in the inertial frame at propagation
instant.
- [`OrbitPropagator`](@ref): Structure with the initialized parameters.
- [`OrbitPropagator{Tepoch, T}`](@ref): Structure with the initialized parameters.
"""
function propagate_to_epoch(
prop::Val,
Expand Down

0 comments on commit 6f1ee91

Please sign in to comment.