Skip to content

Commit

Permalink
Merge pull request #184 from AurelienJaquier/fix-docs
Browse files Browse the repository at this point in the history 
Fix warnings in sphinx and enforce tox to fail on warnings
  • Loading branch information
@AurelienJaquier
AurelienJaquier authored Jun 21, 2024
2 parents 348d3a8 + bfe1040 commit 0e9654f
Show file tree
Hide file tree
Showing 13 changed files with 321 additions and 249 deletions.
50 changes: 25 additions & 25 deletions bluepyefe/ecode/DeHyperPol.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
"""
Copyright (c) 2022, EPFL/Blue Brain Project
This file is part of BluePyEfe <https://github.com/BlueBrain/BluePyEfe>
This file is part of BluePyEfe <https://github.com/BlueBrain/BluePyEfe>
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License version 3.0 as published
by the Free Software Foundation.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License version 3.0 as published
by the Free Software Foundation.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
import logging
import numpy
Expand All @@ -34,20 +34,20 @@ class DeHyperPol(Recording):
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
: : : :
: _________________ : :
: | | : :
: | | : :
|_______________| | : ___________
^ ^ | : | ^
: : | : | :
: : | : | :
: : |____________| :
: : ^ ^ :
: : : : :
: : : : :
t=0 ton tmid toff tend
`` hypamp hypamp+amp hypamp+amp2 hypamp ``
`` : : : : ``
`` : _________________ : : ``
`` : | | : : ``
`` : | | : : ``
``|_______________| | : ___________ ``
``^ ^ | : | ^ ``
``: : | : | : ``
``: : | : | : ``
``: : |____________| : ``
``: : ^ ^ : ``
``: : : : : ``
``: : : : : ``
``t=0 ton tmid toff tend``
"""

def __init__(
Expand Down
30 changes: 15 additions & 15 deletions bluepyefe/ecode/HyperDePol.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,21 @@ class HyperDePol(Recording):
can usually vary from -40% to -160% of rheobase.
hypamp hypamp+amp hypamp+amp2 hypamp
: : : :
: : _____________________ :
: : | | :
: : | | :
: : | | :
: : | | :
: : | | :
|_______________ : | |___________
^ | : | ^ ^
: |___________________| : :
: ^ ^ : :
: : : : :
: : : : :
t=0 ton tmid toff tend
`` hypamp hypamp+amp hypamp+amp2 hypamp ``
`` : : : : ``
`` : : _____________________ : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
``|_______________ : | |___________ ``
``^ | : | ^ ^ ``
``: |___________________| : : ``
``: ^ ^ : : ``
``: : : : : ``
``: : : : : ``
``t=0 ton tmid toff tend``
"""

def __init__(
Expand Down
24 changes: 12 additions & 12 deletions bluepyefe/ecode/SpikeRec.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,18 @@ class SpikeRec(Recording):

"""SpikeRec current stimulus
hypamp hypamp+amp hypamp hypamp+amp . . .
: : : :
: _________________ : _________________ _________________
: | | : | | | |
: | | : | | * len(tspike) | |
: | | : | | . . . | |
: | | : | | | |
|_______________| |__________| |__ __| |___
: : : : : ^
: : : : : :
: : : : : :
<--tspike[0]--><-spike_duration-><- delta -><-spike_duration-> . . . tend
`` hypamp hypamp+amp hypamp hypamp+amp . . . ``
`` : : : : ``
`` : _________________ : _________________ _________________ ``
`` : | | : | | | | ``
`` : | | : | | * len(tspike) | | ``
`` : | | : | | . . . | | ``
`` : | | : | | | | ``
``|_______________| |__________| |__ __| |___ ``
``: : : : : ^ ``
``: : : : : : ``
``: : : : : : ``
`` <--tspike[0]--><-spike_duration-><- delta -><-spike_duration-> . . . tend``
"""

Expand Down
38 changes: 19 additions & 19 deletions bluepyefe/ecode/negCheops.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,25 @@ class NegCheops(Recording):
"""NegCheops current stimulus
hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp
: : : : : : :
: : : : : : :
|__________ : ____________ : ____________ : ____________
: :\ : /: :\ : /: :\ : /: ^
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ / : : \ / : : \ / : :
: : ' : : ' : : ' : :
: : : : : : : :
t=0 ton t1 t2 t3 t4 toff tend
`` hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp ``
`` : : : : : : : ``
`` : : : : : : : ``
``|__________ : ____________ : ____________ : ____________ ``
``: :\ : /: :\ : /: :\ : /: ^ ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ / : : \ / : : \ / : : ``
``: : ' : : ' : : ' : : ``
``: : : : : : : : ``
``t=0 ton t1 t2 t3 t4 toff tend``
"""

def __init__(
Expand Down
38 changes: 19 additions & 19 deletions bluepyefe/ecode/posCheops.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,25 @@ class PosCheops(Recording):

"""PosCheops current stimulus
hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp
: : : : : : :
: . : . : . :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
|__________ / \ __________ / \ __________ / \ __________
: : : : : : : ^
: : : : : : : :
: : : : : : : :
t=0 ton t1 t2 t3 t4 toff tend
`` hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp ``
`` : : : : : : : ``
`` : . : . : . : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
``|__________ / \ __________ / \ __________ / \ __________ ``
``: : : : : : : ^ ``
``: : : : : : : : ``
``: : : : : : : : ``
``t=0 ton t1 t2 t3 t4 toff tend``
"""

def __init__(
Expand Down
Loading

0 comments on commit 0e9654f

Please sign in to comment.