From 63db811bc670cb2f691ae8ec916e448f0ede8599 Mon Sep 17 00:00:00 2001 From: Tamas Gal <himself@tamasgal.com> Date: Wed, 23 Oct 2024 16:20:46 +0200 Subject: [PATCH] Improve docs --- src/math.jl | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/math.jl b/src/math.jl index 20db13a..95883c1 100644 --- a/src/math.jl +++ b/src/math.jl @@ -95,7 +95,10 @@ the Fibonacci lattice. fibonaccisphere(α::Float64) = fibonaccisphere(Int(ceil((195.39/α)^2))) """ -Create `S` directions inside a cone with an opening angle of `θ` [deg] which points towards `dir`. + +Create `S` directions inside a cone with an opening angle of `θ` [deg] (angle +between cone axis and its surface) which points towards `dir`. + """ function fibonaccicone(dir::Direction{Float64}, S::Integer, θ::Float64) N = Int(ceil(S / sin(deg2rad(θ)/2)^2)) @@ -116,8 +119,9 @@ end """ -Creates directions with a median angular separation of `α` [deg] inside a cone with an -opening angle of `θ` [deg] pointing towards `dir`. +Creates directions with a median angular separation of `α` [deg] inside a cone +with an opening angle of `θ` [deg] (angle between the cone axis and its surface) +pointing towards `dir`. """ function fibonaccicone(dir::Direction{Float64}, α::Float64, θ::Float64) -- GitLab