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.

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

[Doc] improve spike_train_generation.spike_extraction parameter documentation #641

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Moritz-Alexander-Kern
Copy link
Member

Enhanced description for the spike_interval parameter to clarify the bahavior and effects on the resulting spike train aswell as the choice of the chosen default values.

Added notes section to clarify the behavior when time_stamps is set to None and what the expected results are.

This PR adresses #415 .

@Moritz-Alexander-Kern Moritz-Alexander-Kern added the documentation Indicates a need for improvements or additions to documentation label Sep 23, 2024
@Moritz-Alexander-Kern Moritz-Alexander-Kern linked an issue Sep 23, 2024 that may be closed by this pull request
@coveralls
Copy link
Collaborator

coveralls commented Sep 23, 2024

Coverage Status

coverage: 88.257% (-0.1%) from 88.401%
when pulling caa10f4 on INM-6:enh/spike_extraction_documentation
into 123ca04 on NeuralEnsemble:master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Spike Extraction parameters
2 participants