fix: correct Synapse base class, stale docstrings, and minor type issues#792
Open
haoyu-haoyu wants to merge 2 commits into
Open
fix: correct Synapse base class, stale docstrings, and minor type issues#792haoyu-haoyu wants to merge 2 commits into
haoyu-haoyu wants to merge 2 commits into
Conversation
… issues - Add missing `self` parameter to `Synapse.update_states()` and `Synapse.compute_current()` base class methods. All concrete subclasses already include `self`; the base class was inconsistent. - Update current unit in docstrings from `uA/cm2` to `mA/cm2` in `channel.py`. The unit was changed in v0.5.0 but the docstrings were not updated. - Fix invalid `np.ndarray[bool]` type annotation in `connect.py`. `np.ndarray` does not support subscript type parameters. - Remove duplicate `Callable` import in `integrate.py`. It was imported from both `collections.abc` and `typing`.
michaeldeistler
approved these changes
Mar 28, 2026
Contributor
michaeldeistler
left a comment
michaeldeistler
left a comment
There was a problem hiding this comment.
Thanks for opening this! All proposed changes look good to me.
Could you add a line to the CHANGELOG.md which briefly describes these changes? Thank you!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add missing
selfparameter toSynapse.update_states()andSynapse.compute_current()injaxley/synapses/synapse.py. All concrete subclasses (IonotropicSynapse,TanhConductanceSynapse, etc.) correctly includeself, but the base class methods were missing it.Update current unit in docstrings from
uA/cm2tomA/cm2injaxley/channels/channel.py. The unit was changed in v0.5.0 (with a runtime check enforcingcurrent_is_in_mA_per_cm2 = True), but the class docstring andcompute_currentreturn docstring still referenced the old unit.Fix invalid type annotation
np.ndarray[bool]→np.ndarrayinjaxley/connect.py(relates to issue faulty type subscript #615).np.ndarraydoes not support subscript type parameters in standard Python.Remove duplicate
Callableimport injaxley/integrate.py. It was imported from bothcollections.abc(Python 3.9+ preferred) andtyping.Test plan
Synapsesubclasses already haveselfand are unaffected