Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename spike_detector to something more descriptive #1642

Closed
schmitts opened this issue Sep 7, 2021 · 5 comments · Fixed by #1976
Closed

Rename spike_detector to something more descriptive #1642

schmitts opened this issue Sep 7, 2021 · 5 comments · Fixed by #1976
Labels
enhancement interface Anything user-facing, including public C++ and Python APIs.

Comments

@schmitts
Copy link
Contributor

schmitts commented Sep 7, 2021

The term spike_detector is confusing. Proposed renamings:

  • membrane_threshold_detector
  • mtd
@schmitts schmitts added AEP Arbor Enhancement Proposal enhancement labels Sep 7, 2021
@brenthuisman brenthuisman removed the AEP Arbor Enhancement Proposal label Sep 29, 2021
@brenthuisman brenthuisman changed the title AEP: rename spike_detector to something more descriptive Rename spike_detector to something more descriptive Sep 29, 2021
@thorstenhater thorstenhater added the interface Anything user-facing, including public C++ and Python APIs. label Sep 8, 2022
@thorstenhater
Copy link
Contributor

thorstenhater commented Sep 13, 2022 •
edited
Loading

I agree that the name leaks the implementation details. But, a term should be

  • descriptive
  • not too long
  • not an acronym

I have no good solution to offer, sadly, so suggest away ;)

@schmitts
Copy link
Contributor Author

schmitts commented Sep 13, 2022 •
edited
Loading

membrane_voltage_crossing_threshold_from_below_detector

just threshold_detector maybe?

@thorstenhater
Copy link
Contributor

That's literally the name of the C++ class

@schmitts
Copy link
Contributor Author

That's literally the name of the C++ class

Then let's rename the Python wrapper and make spike_detector issue a deprecation warning for a while until we delete it.

@thorstenhater thorstenhater mentioned this issue Sep 13, 2022
Merged
@thorstenhater
Copy link
Contributor

There you go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement interface Anything user-facing, including public C++ and Python APIs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

🐍 Rename spike detector -> threshold detector thorstenhater/arbor
3 participants
@schmitts @brenthuisman @thorstenhater