Merge pull request #505 from AkitsuFaye/master

Changed the order of code blocks in the docs of hh models and lif models

Author: chaoming0625

brainpy/_src/dyn/neurons/hh.py

@@ -180,7 +180,7 @@ def update(self, x=None):
     return super().update(x)
 
 
-class HHLTC(HHTypedNeuron):
+class HHLTC(NeuDyn):
   r"""Hodgkin–Huxley neuron model with liquid time constant.
 
   **Model Descriptions**
@@ -222,6 +222,20 @@ class HHLTC(HHTypedNeuron):
   methods available to analyze the system. Certain properties and general behaviors,
   such as limit cycles, can be proven to exist.
 
+
+  References
+  ----------
+
+  .. [1] Hodgkin, Alan L., and Andrew F. Huxley. "A quantitative description
+         of membrane current and its application to conduction and excitation
+         in nerve." The Journal of physiology 117.4 (1952): 500.
+  .. [2] https://en.wikipedia.org/wiki/Hodgkin%E2%80%93Huxley_model
+  .. [3] Ashwin, Peter, Stephen Coombes, and Rachel Nicks. "Mathematical
+         frameworks for oscillatory network dynamics in neuroscience."
+         The Journal of Mathematical Neuroscience 6, no. 1 (2016): 1-92.
+
+  **Examples**
+
   Here is a simple usage example:
 
   .. code-block:: python
@@ -275,17 +289,6 @@ class HHLTC(HHTypedNeuron):
 
 
 
-  References
-  ----------
-
-  .. [1] Hodgkin, Alan L., and Andrew F. Huxley. "A quantitative description
-         of membrane current and its application to conduction and excitation
-         in nerve." The Journal of physiology 117.4 (1952): 500.
-  .. [2] https://en.wikipedia.org/wiki/Hodgkin%E2%80%93Huxley_model
-  .. [3] Ashwin, Peter, Stephen Coombes, and Rachel Nicks. "Mathematical
-         frameworks for oscillatory network dynamics in neuroscience."
-         The Journal of Mathematical Neuroscience 6, no. 1 (2016): 1-92.
-
 
   """
 
@@ -440,6 +443,19 @@ class HH(HHLTC):
 
       &\beta_n(V) = 0.125 \exp(\frac{-(V + 65)} {80})
 
+  References
+  ----------
+
+  .. [1] Hodgkin, Alan L., and Andrew F. Huxley. "A quantitative description
+         of membrane current and its application to conduction and excitation
+         in nerve." The Journal of physiology 117.4 (1952): 500.
+  .. [2] https://en.wikipedia.org/wiki/Hodgkin%E2%80%93Huxley_model
+  .. [3] Ashwin, Peter, Stephen Coombes, and Rachel Nicks. "Mathematical
+         frameworks for oscillatory network dynamics in neuroscience."
+         The Journal of Mathematical Neuroscience 6, no. 1 (2016): 1-92.
+
+  **Examples**
+
   Here is a simple usage example:
 
   .. code-block:: python
@@ -497,17 +513,6 @@ class HH(HHLTC):
   name: str
     The group name.
 
-  References
-  ----------
-
-  .. [1] Hodgkin, Alan L., and Andrew F. Huxley. "A quantitative description
-         of membrane current and its application to conduction and excitation
-         in nerve." The Journal of physiology 117.4 (1952): 500.
-  .. [2] https://en.wikipedia.org/wiki/Hodgkin%E2%80%93Huxley_model
-  .. [3] Ashwin, Peter, Stephen Coombes, and Rachel Nicks. "Mathematical
-         frameworks for oscillatory network dynamics in neuroscience."
-         The Journal of Mathematical Neuroscience 6, no. 1 (2016): 1-92.
-
   """
 
   def dV(self, V, t, m, h, n, I):
@@ -758,7 +763,7 @@ def update(self, x=None):
     return super().update(x)
 
 
-class WangBuzsakiHHLTC(HHTypedNeuron):
+class WangBuzsakiHHLTC(NeuDyn):
   r"""Wang-Buzsaki model [9]_, an implementation of a modified Hodgkin-Huxley model with liquid time constant.
 
   Each model is described by a single compartment and obeys the current balance equation:
@@ -801,6 +806,15 @@ class WangBuzsakiHHLTC(HHTypedNeuron):
   :math:`\beta_{n}(V)=0.125\exp (-(V+44) / 80)` ; :math:`g_{\mathrm{K}}=9 \mathrm{mS} / \mathrm{cm}^{2}`, and
   :math:`E_{\mathrm{K}}=-90 \mathrm{mV}`.
 
+
+  References
+  ----------
+  .. [9] 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.
+
+  **Examples**
+
   Here is a simple usage example:
 
   .. code-block:: python
@@ -851,11 +865,6 @@ class WangBuzsakiHHLTC(HHTypedNeuron):
   name: str
     The group name.
 
-  References
-  ----------
-  .. [9] 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.
 
   """
 
@@ -1008,6 +1017,15 @@ class WangBuzsakiHH(WangBuzsakiHHLTC):
   :math:`\beta_{n}(V)=0.125\exp (-(V+44) / 80)` ; :math:`g_{\mathrm{K}}=9 \mathrm{mS} / \mathrm{cm}^{2}`, and
   :math:`E_{\mathrm{K}}=-90 \mathrm{mV}`.
 
+
+  References
+  ----------
+  .. [9] 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.
+
+  **Examples**
+
   Here is an example:
 
   .. code-block:: python
@@ -1058,12 +1076,6 @@ class WangBuzsakiHH(WangBuzsakiHHLTC):
   name: str
     The group name.
 
-  References
-  ----------
-  .. [9] 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.
-
   """
 
   def dV(self, V, t, h, n, I):