Skip to content

Commit

Permalink
fix doc mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
mileslucas committed Sep 24, 2022
1 parent 10f223c commit 2b0a95b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/src/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Let's dive straight into some of the features Orbits.jl offers. Keplerian orbits are the backbone of astrodynamics, and we provide a "kitchen-sink" style [`KeplerianOrbit`](@ref). This means it wall try and parse whichever keyword arguments you provide, with units, uncertainties, and more thanks to Julia's composability. Here we present the orbital solution for the binary system SAO 136799, as derived by Tokovinin et al. 2015[^1]

```@example kep
using Measurements
using Orbits
using Plots
using Unitful
Expand All @@ -15,11 +16,11 @@ using UnitfulRecipes
distance = inv(6.92e-3)u"pc"
orbit = KeplerianOrbit(;
period = 40.57 ± 0.19)u"yr",
period = (40.57 ± 0.19)u"yr",
ecc = 0.42 ± 0.009,
Omega = 318.6 ± 0.6)u"°",
tp = 1972.12 ± 0.16)u"yr",
incl = 54.7 ± 0.6)u"°",
Omega = (318.6 ± 0.6)u"°",
tp = (1972.12 ± 0.16)u"yr",
incl = (54.7 ± 0.6)u"°",
a = (0.154 ± 0.001)u"arcsecond" * distance |> u"AU",
omega = (72.6 ± 0.8)u"°",
)
Expand Down

2 comments on commit 2b0a95b

@mileslucas
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/68875

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 2b0a95b2597ac3550e9b45ea5359eabedb2a089d
git push origin v0.1.0

Please sign in to comment.