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

Add additional reference to Izhikevich model documentation #2216

Merged
merged 2 commits into from
Dec 6, 2021

Conversation

jessica-mitchell
Copy link
Contributor

This PR adds some text to the model doc mentioning differences between NEST and the original author's model. Includes reference to Pauli et al. paper. 2018.

Not sure if this needs a lot more detail in the documentation or if link suffices.

@jessica-mitchell jessica-mitchell added I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Nov 22, 2021
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Nov 23, 2021
Copy link
Contributor

@clinssen clinssen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would move to reject (sorry!)

The paragraph about the numerics is redundant with the preceding paragraph, that already covers these issues, and how these are addressed in the NEST model. The comment about STDP does not seem relevant to this model as it is a neuron model without any direct relationship to synaptic plasticity.

Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to agree with @clinssen, but still think a reference to Pauli et al. would be a good addition to the model documentation.

models/izhikevich.h Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Dec 1, 2021
@jougs jougs added this to To do in Models via automation Dec 1, 2021
Co-authored-by: Jochen Martin Eppler <j.eppler@fz-juelich.de>
Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jougs jougs changed the title Add text to Izhikevich model doc Add additional reference to Izhikevich model documentation Dec 6, 2021
@jougs jougs merged commit 44c52fe into nest:master Dec 6, 2021
Documentation automation moved this from Review to Done Dec 6, 2021
@clinssen clinssen moved this from To do to Done in Models Nov 29, 2022
@jessica-mitchell jessica-mitchell deleted the add-izhikevich-note branch April 17, 2024 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Models
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants