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

Correct a few typos in documentation comments #855

Merged
merged 4 commits into from
Nov 30, 2017
Merged

Conversation

aserenko
Copy link
Contributor

@aserenko aserenko commented Nov 9, 2017

post-syapic -> postsynaptic,
neruons -> neurons,
is achieve -> is achieved.

post-syapic -> postsynaptic,
neruons -> neurons,
is achieve -> is achieved.
Conflicts:
	models/iaf_neuron.h

Resolve merge conflict caused by iaf_neuron model removal
@terhorstd terhorstd added ZC: Documentation DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: PR Created DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Nov 27, 2017
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

The ipynb filenames are still not completely correct. Could you please change IAF_Neurons_Singularity.ipynb to IAF_neurons_singularity.ipynb. Thanks.

IAF_Neurons_Singularity.ipynb -> IAF_neurons_singularity.ipynb,
because this is how it is named there in doc/model_details.
The variable TauR in comments about refractory period is changed
to how the corresponding refractory variables are named in the code.
Also, leed -> lead, and a comma added before "defining" in
"A time object r is constructed defining representation", because
it is r what is defining, not the construction.
@aserenko
Copy link
Contributor Author

A few more changes, even less significant (involving comments that are mostly non-documenting), are added; let them be in the same request.

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

Looks good, thanks

@heplesser
Copy link
Contributor

Merging after single review as it this PR just concerns typos in documentation.

@heplesser heplesser merged commit a77e4a8 into nest:master Nov 30, 2017
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. ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants