Improve docstrings

Theoretical-Neuroscience-Group · Feb 21, 2022 · e775138 · e775138 · simsurace · Feb 21, 2022
1 parent 8b29947
commit e775138
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 14 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -3,10 +3,20 @@
 ## Models
 ```@docs
 AbstractBinomialModel
-BinomialModel
 BinomialGridModel
+BinomialGridModel(
+    Nind, pind, qind, σind, τind,
+    Nrng, prng, qrng, σrng, τrng
+)
+BinomialGridModel(m_out, my_Nrng, my_prng, my_qrng, my_σrng, my_τrng)
+BinomialModel
+BinomialModel(Nmax, m_out, device = :gpu)
+BinomialModel(m_out, my_Nrng, my_prng, my_qrng, my_σrng, my_τrng)
+BinomialModel(model::BinomialGridModel)
 ScalarBinomialModel
 BinomialState
+BinomialState(Nmax, m_out, m_in, device = :gpu)
+ScalarBinomialState(Nmax, device = :cpu)
 ScalarBinomialState
 BinomialObservation
 propagate!(state::BinomialState, model, dt)
@@ -25,7 +35,12 @@ get_step
 ```@docs
 NestedParticleFilter
 NestedParticleState
-update!
+NestedParticleState(m_out, m_in, my_Nrng, my_prng, my_qrng, my_σrng, my_τrng)
+update!(
+    filterstate::NestedParticleState,
+    observation::BinomialObservation,
+    filter::NestedParticleFilter
+)
 jitter!
 likelihood
 likelihood_resample!
@@ -50,6 +65,7 @@ MyopicFast_tau
 ```@docs
 NestedFilterSimulation
 initialize!
+propagate!(sim::NestedFilterSimulation)
 run!
 Recording
 update!(rec::Recording, sim, time)

diff --git a/src/models.jl b/src/models.jl
@@ -2,27 +2,27 @@
     AbstractBinomialModel
 
 An abstract type for binomial synaptic models.
-A binomial model always has parameters 
-`N`: number of release sites
-`p`: probability of release
-`q`: quantum of release
-`σ`: observation noise
-`τ`: refilling time constant
+A binomial model always has the following parameters:
+- `N`: number of release sites
+- `p`: probability of release
+- `q`: quantum of release
+- `σ`: observation noise
+- `τ`: refilling time constant
 """
 abstract type AbstractBinomialModel end
 
 """
     AbstractBinomialState
 
 An abstract type for binomial model states.
-A binomial model state has to have at least variable 
-`n`: number of readily releasable vesicles
-`k`: number of released vesicles
+A binomial model state has to have the following variables:
+- `n`: number of readily releasable vesicles
+- `k`: number of released vesicles
 """
 abstract type AbstractBinomialState end
 
 """
-    BinomialModel{T1,T2}
+    BinomialModel(N, p, q, σ, τ)
 
 The standard structure for a binomial model or model ensemble.
 """
@@ -35,7 +35,11 @@ struct BinomialModel{T1,T2} <: AbstractBinomialModel
 end
 
 """
-    BinomialGridModel{T1, T2, T3, T4, T5}
+    BinomialGridModel(
+        Nind, pind, qind, σind, τind,
+        Nrng, prng, qrng, σrng, τrng,
+        N,    p,    q,    σ,    τ
+       )
 
 A binomial model ensemble whose parameters are constrained to live on a grid
 defined by `Nrng`, `prng`, etc.
@@ -200,7 +204,7 @@ function ScalarBinomialModel(N::Integer, p, q, σ, τ, device = :cpu)
 end
 
 """
-    BinomialState{T}
+    BinomialState(n, k)
 
 An ensemble of states of the binomial model.
 """