Skip to content

Fix formatting in model docstrings #1210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions models/neurons/iaf_psc_alpha_neuron.nestml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@
# relevant measures analytically.
#
# .. note::
# If tau_m is very close to tau_syn_exc or tau_syn_inh, numerical problems
# may arise due to singularities in the propagator matrics. If this is
# the case, replace equal-valued parameters by a single parameter.
#
# If tau_m is very close to tau_syn_exc or tau_syn_inh, numerical problems
# may arise due to singularities in the propagator matrics. If this is
# the case, replace equal-valued parameters by a single parameter.
#
# For details, please see ``IAF_neurons_singularity.ipynb`` in
# the NEST source code (``docs/model_details``).
Expand Down
12 changes: 7 additions & 5 deletions models/neurons/iaf_psc_exp_htum_neuron.nestml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@
# refractoriness of the model if equivalent to the other models of NEST.
#
# .. note::
# This neuron model can only be used in combination with a fixed
# simulation resolution (timestep size).
#
# This neuron model can only be used in combination with a fixed
# simulation resolution (timestep size).
#
# .. note::
# If tau_m is very close to tau_syn_exc or tau_syn_inh, numerical problems
# may arise due to singularities in the propagator matrics. If this is
# the case, replace equal-valued parameters by a single parameter.
#
# If tau_m is very close to tau_syn_exc or tau_syn_inh, numerical problems
# may arise due to singularities in the propagator matrics. If this is
# the case, replace equal-valued parameters by a single parameter.
#
# For details, please see ``IAF_neurons_singularity.ipynb`` in
# the NEST source code (``docs/model_details``).
Expand Down
4 changes: 2 additions & 2 deletions models/neurons/wb_cond_exp_neuron.nestml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
# ++++++++++
#
# .. [1] Wang, X.J. and Buzsaki, G., (1996) Gamma oscillation by synaptic
# inhibition in a hippocampal interneuronal network model. Journal of
# neuroscience, 16(20), pp.6402-6413.
# inhibition in a hippocampal interneuronal network model. Journal of
# neuroscience, 16(20), pp.6402-6413.
#
# See Also
# ++++++++
Expand Down
4 changes: 2 additions & 2 deletions models/neurons/wb_cond_multisyn_neuron.nestml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
# ++++++++++
#
# .. [1] Wang, X.J. and Buzsaki, G., (1996) Gamma oscillation by synaptic
# inhibition in a hippocampal interneuronal network model. Journal of
# Neuroscience, 16(20), pp.6402-6413.
# inhibition in a hippocampal interneuronal network model. Journal of
# Neuroscience, 16(20), pp.6402-6413.
#
# See also
# ++++++++
Expand Down
1 change: 1 addition & 0 deletions models/synapses/neuromodulated_stdp_synapse.nestml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#
# References
# ++++++++++
#
# .. [1] Potjans W, Morrison A, Diesmann M (2010). Enabling functional neural
# circuit simulations with distributed computing of neuromodulated
# plasticity. Frontiers in Computational Neuroscience, 4:141.
Expand Down
Loading