Skip to content

Commit

Permalink
fix broken docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mileslucas committed Sep 28, 2022
1 parent e944e08 commit 3435eb9
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Orbits = "88f3d70c-3a4c-11ed-1389-4902f2e49de8"
StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
Transits = "2e59a628-7bac-4d38-8059-3a73ba0928ab"
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
Expand Down
2 changes: 2 additions & 0 deletions src/Transits.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Compute the relative flux by calculating the impact parameter at time `t` from t
# Examples
```jldoctest orb
julia> using Orbits
julia> ld = PolynomialLimbDark([0.4, 0.26]);
julia> orbit = SimpleOrbit(period=3, duration=1);
Expand Down
10 changes: 5 additions & 5 deletions src/distributions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ A non-informative prior for two-parameter limb-darkening coefficients using *tri
# Examples
```jldoctest
julia> using Random; rng = Random.seed!(10);
julia> using StableRNGs; rng = StableRNG(10);
julia> rand(rng, Kipping13())
2-element Vector{Float64}:
0.24716310305467298
0.08836997249298882
0.3361047299132651
-0.025681638815114587
julia> rand(rng, Kipping13(), 5)
2×5 Matrix{Float64}:
0.0664907 0.124817 1.00732 0.806902 0.74165
0.520411 0.222718 -0.389412 -0.314755 0.0768429
0.0621057 0.992689 1.77965 0.784055 0.186386
0.0659477 -0.236613 -0.795884 -0.187791 0.592194
```
# References
Expand Down
1 change: 1 addition & 0 deletions src/secondary.jl
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ where $f_p$ is to the primary flux, $f_s$ is to the secondary flux, and $\eta$ i
# Examples
```jldoctest second
using Orbits
# equal size and limb darkening
r = 1.0
u = [0.4, 0.26]
Expand Down

0 comments on commit 3435eb9

Please sign in to comment.