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 note to aeif models about refractory period and peculiarities #3296

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Aug 21, 2024

Fixes #3088

This PR adds a note to all aeif models, including the reference if needed based on the comment in #3088.
The technical reason was left out, since the focus should be on usage imo.

See output from Read the Docs here: https://nest-simulator--3296.org.readthedocs.build/en/3296/models/aeif_psc_exp.html

@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Aug 21, 2024
@clinssen
Copy link
Contributor

The formulation "The default refractory period [...] is zero, [...]. This means if the refractory period is zero, [...]" is perhaps a little bit of a non sequitur. Suggest to remove "This means" from the second sentence.

@clinssen clinssen self-requested a review August 26, 2024 09:53
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
Status: In progress
Development

Successfully merging this pull request may close these issues.

aeif-model documentation does not point out peculiarities
2 participants