Improve docstrings of DeHyperPol, HyperDePol and sAHP

BlueBrain · Dec 5, 2023 · c469c4b · c469c4b
1 parent 40ec514
commit c469c4b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/bluepyefe/ecode/DeHyperPol.py b/bluepyefe/ecode/DeHyperPol.py
@@ -31,6 +31,9 @@ class DeHyperPol(Recording):
 
     """DeHyperpol current stimulus
 
+    The hyperpolarizing step is usually fixed at 150% of rheobase, and the hyperpolarizing step
+    can usually vary from -40% to -160% of rheobase
+
          hypamp        hypamp+amp      hypamp+amp2    hypamp
            :                :               :            :
            :         _________________      :            :

diff --git a/bluepyefe/ecode/HyperDePol.py b/bluepyefe/ecode/HyperDePol.py
@@ -31,6 +31,9 @@ class HyperDePol(Recording):
 
     """HyperDepol current stimulus
 
+    The hyperpolarizing step is usually fixed at 100% of rheobase, and the hyperpolarizing step
+    can usually vary from -40% to -160% of rheobase.
+
 
           hypamp         hypamp+amp           hypamp+amp2         hypamp
             :                :                     :                :

diff --git a/bluepyefe/ecode/sAHP.py b/bluepyefe/ecode/sAHP.py
@@ -32,6 +32,9 @@ class SAHP(Recording):
 
     """sAHP current stimulus
 
+    The long step (here amp) is usually fixed at 40% of rheobase, and the short step (here amp2)
+    can usually vary from 150% to 300% of rheobase.
+
 
        hypamp        hypamp+amp       hypamp+amp2        hypamp+amp           hypamp
          :                :                :                 :                   :