Removes jldoctest from AstrodynamicalCalculations

JuliaAstro · Oct 9, 2024 · a4723ac · a4723ac
1 parent a5305ca
commit a4723ac
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/lib/AstrodynamicalCalculations/docs/Project.toml b/lib/AstrodynamicalCalculations/docs/Project.toml
@@ -1,4 +1,5 @@
 [deps]
+AstrodynamicalCalculations = "c0cf9fb7-f496-4999-a425-c50785d1b88b"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"

diff --git a/lib/AstrodynamicalCalculations/docs/src/index.md b/lib/AstrodynamicalCalculations/docs/src/index.md
@@ -24,7 +24,7 @@ These simple calculations are provided by the `R2BPCalculations` submodule withi
     The size of all of the vectors in these calculations are known at compile time. 
     You can _drastically_ improve performance by using `StaticArrays` types, i.e. `SVector`.
 
-```jldoctest usage
+```julia
 julia> using AstrodynamicalCalculations
 
 julia> r = [0.0, 11681.0, 0.0];     # km
@@ -36,9 +36,9 @@ julia> μ = 398600.4354360959;       # km³ s⁻²
 julia> e, a, i, Ω, ω, ν = cartesian_to_keplerian(r, v, μ) 
 (0.723452708202361, 24509.265399338536, 2.6442542356744734, 1.5707963267948966, 4.712449617676915, 1.5707356895026707)
 
-julia> T = orbital_period(a, μ) 
+julia> dt = orbital_period(a, μ)
 38186.19850882009
 
-julia> rₙ, vₙ = kepler(r, v, μ, 2.5T)
-([36872.96963754877, -2574.241491333036, 20016.549742861007], [-0.3141726028666592, -1.6044679459972122, -0.17054909314167882])
+julia> rₙ, vₙ = kepler(r..., v..., μ, dt)
+(x = 0.0, y = 11681.0, z = 0.0, ẋ = 5.134, ẏ = 4.226, ż = 2.787)
 ```