Fix various typos in the documentation#2787
Conversation
Fixed typo
Namespace plt is used in subsequent script and thus requires to be imported.
Correct and not a a typo. Apologies for the misunderstanding.
The parameter `V_m` should not be used as a string literal when setting its values.
`np.arange(a, b)` includes `a` but excludes `b`, hence b needs to incremented to `b+1` to include `b` in the range. `np.arange(1, N+1)` would yield an error in mismatched lengths of the two arguments of `plt.xticks()`.
Incorrect variable and template `[node id]` was not filled in with the NEST v2.x returned global-id variable, `gid`.
`print_all` is not an attribute of `SynapseCollection` object, instead `print_full` is.
The previous section (e.g., fixed indegree) used `A` and `B` to refer to the pre- and post-synaptic population respectively. Hence, update the variable usage to match previous section's convention thus aligning with the example code given.
`syn_spec` is pointing to the previous codeblock's `CollocatedSynapses` object, whereas `syn_spec_dict` points to the immediate `CollocatedSynapses` object.
|
@aoot Thank you for your contribution! May I ask you to fill in the NEST Copyright Transfer Agreement and so send it to info@nest-initiative.org? |
heplesser
left a comment
There was a problem hiding this comment.
Just a formal block until the CTA is in place.
|
@aoot The |
|
Just pulled the master into my fork. Thanks! |
heplesser
left a comment
There was a problem hiding this comment.
Formalities are ok, approving.
jessica-mitchell
left a comment
There was a problem hiding this comment.
Thanks @aoot for contributing to our documentation. It's very appreciated. I just have one comment that needs addressing.
nicolossus
left a comment
There was a problem hiding this comment.
@aoot Thanks for the contribution. I have some small comments. I also agree with @jessica-mitchell that numpy.foo instead of np.foo should be used to be explicit.
Co-authored-by: Nicolai Haug <39106781+nicolossus@users.noreply.github.com>
Co-authored-by: Nicolai Haug <39106781+nicolossus@users.noreply.github.com>
Co-authored-by: Nicolai Haug <39106781+nicolossus@users.noreply.github.com>
Co-authored-by: Nicolai Haug <39106781+nicolossus@users.noreply.github.com>
For clarity, using the numpy namespace because the documentation does not include explicit import as statement.
The unit should be nano-siemens instead of nano-seconds.
|
@aoot could you please resolve the conflicts and commit the suggestion from @nicolossus? Once that's sorted we can probably merge this PR, thanks :) |
|
Thank you for your patience! I've resolved the conflicts. |
Co-authored-by: Nicolai Haug <39106781+nicolossus@users.noreply.github.com>
Various on going fix suggestions.