Merge pull request #424 from brainpy/doc

update docs

Author: chaoming0625

brainpy/_src/dyn/_docs.py

@@ -11,6 +11,9 @@
     detach_spk: bool.
     method: str. The numerical integration method.
     spk_type: The spike data type.
+    spk_reset: The way to reset the membrane potential when the neuron generates spikes.
+        This parameter only works when the computing mode is ``TrainingMode``.
+        It can be ``soft`` and ``hard``. Default is ``soft``.
 '''.strip()
 
 ref_doc = '''

brainpy/_src/dyn/ions/base.py

@@ -171,8 +171,8 @@ def current(self, V, C=None, E=None, external: bool = False):
 
     Args:
       V: The membrane potential.
-      C: The ion concentration.
-      E: The reversal potential.
+      C: The given ion concentration.
+      E: The given reversal potential.
       external: Include the external current.
 
     Returns:

brainpy/_src/dyn/neurons/base.py

@@ -29,6 +29,7 @@ def __init__(
 
       spk_fun: Callable = bm.surrogate.InvSquareGrad(),
       spk_type: Any = None,
+      spk_reset: str = 'soft',
       detach_spk: bool = False,
   ):
     super().__init__(size=size,
@@ -38,6 +39,7 @@ def __init__(
                      sharding=sharding,
                      method=method)
 
+    self.spk_reset = spk_reset
     self.spk_fun = is_callable(spk_fun)
     self.detach_spk = detach_spk
     self._spk_type = spk_type