From 3435eb957d5f9440c01507353a5656c775ebc287 Mon Sep 17 00:00:00 2001 From: Miles Lucas Date: Wed, 28 Sep 2022 01:24:34 -1000 Subject: [PATCH] fix broken docstrings --- docs/Project.toml | 1 + src/Transits.jl | 2 ++ src/distributions.jl | 10 +++++----- src/secondary.jl | 1 + 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index d26ac8f..56b78bc 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -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" diff --git a/src/Transits.jl b/src/Transits.jl index 282abd9..80d6018 100644 --- a/src/Transits.jl +++ b/src/Transits.jl @@ -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); diff --git a/src/distributions.jl b/src/distributions.jl index 9859be8..384baa8 100644 --- a/src/distributions.jl +++ b/src/distributions.jl @@ -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 diff --git a/src/secondary.jl b/src/secondary.jl index 6955c04..9d2fa6a 100644 --- a/src/secondary.jl +++ b/src/secondary.jl @@ -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]