Link PyNEST functions in documentaton #2010
Conversation
jessica-mitchell
added
I: No breaking change
|
@steffengraber, @jasperalbers: could you please review? If you don't have time right now, please quickly indicate this, so we can try to find other reviewers. Thanks! |
doc/userdoc/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
| @@ -18,13 +18,13 @@ target nodes that will be connected in an all-to-all fashion. | |||
| Each call to the function will establish the connectivity between pre- | |||
| and post-synaptic populations according to a certain pattern or | |||
| rule. The desired pattern is specified by simply stating the rule name | |||
| as third argument to ``Connect()``, or by setting the key `rule` in | |||
| the `connectivity specification` dictionary ``conn_spec`` alongside | |||
| as third argument to ``Connect()``, or by setting the key ``rule`` in | |||
There was a problem hiding this comment.
Is this occurrence of Connect() rather than :py:func:.Connect intended? You use the new way in lines 12 and 38 while the old one is used here and in line 27.
There was a problem hiding this comment.
Yes, I was trying to only link each function once per paragraph or section.
doc/userdoc/guides/spatial/guide_spatially_structured_networks.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Jasper Albers <[email protected]>
Co-authored-by: Jasper Albers <[email protected]>
|
Hi @jasperalbers I have addressed your comments, could you please take another look? thanks! |
|
|
||
| Collocated synapses | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
| It is now possible to create connections with several synapses simultaneously. The different synapse dictionaries will | ||
| then be applied to each source-target pair. To create these collocated synapses, ``CollocatedSynapses()`` must be used | ||
| as the `syn_spec` argument of ``Connect``, instead of the usual syn_spec dictionary argument. The constructor | ||
| then be applied to each source-target pair. To create these collocated synapses, :py:func:`.CollocatedSynapses` must be used |
There was a problem hiding this comment.
needs to be :py:class:.CollocatedSynapses``
doc/userdoc/guides/nest2_to_nest3/nest3_features/nest3_handling_connections.rst
Outdated
Show resolved
Hide resolved
…g_connections.rst
|
@jessica-mitchell: I'll merge as soon as you fix the conflicts ;-) |
|
@jessica-mitchell: can you maybe merge master again? If that does not solve the static code check problems, I can have a closer look. |
|
I'm merging even thought the one static check still fails. I'll fix that in master. |
This PR provides links to the API functions in the documentation, specifically restructuredtext files in doc/userdoc.
There are still files to update in the nest-3 guides, but waiting for #1929 to be merged, so this is still incomplete.
Note: set() and get() methods are in both SynapseCollection and NodeCollection class, so the class name needs to be included in the link. (This is mentioned in styleguide #1986 )
Resolves #1878