Skip to content

Commit

Permalink
[FIX] Add docstrings for constants
Browse files Browse the repository at this point in the history
  • Loading branch information
mbeyeler committed Jun 20, 2021
1 parent 008f315 commit 4509d2f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pulse2percept/utils/constants.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
"""`DT`, `MIN_AMP`, `ZORDER`"""

# Pulses with net currents smaller than 10 picoamps are considered
# charge-balanced (here expressed in microamps):
#: Pulses with net currents smaller than 10 picoamps are considered
#: charge-balanced (here expressed in microamps).
MIN_AMP = 1e-5

# Sampling time step (ms); defines the duration of the signal edge
# transitions:
#: Sampling time step (ms); defines the duration of the signal edge
#: transitions.
DT = 1e-3


# An enum specifying the zorder values to use in Matplotlib plots, ensuring
# that foreground items (like implants) always appear on top of background
# items (like axon maps):
#: An enum specifying the zorder values to use in Matplotlib plots, ensuring
#: that foreground items (like implants) always appear on top of background
#: items (like axon maps).
ZORDER = {
'front': 9999,
'back': 0,
Expand Down

0 comments on commit 4509d2f

Please sign in to comment.