Merge pull request nest#3616 from clinssen/vt_doc

Add note in docs about how to use volume transmitter during network setup

Author: jessica-mitchell

models/stdp_dopamine_synapse.h

@@ -64,40 +64,41 @@ dopaminergic dynamics is calculated in the synapse itself.
 Parameters
 ++++++++++
 
-=================== ============== ======================================================
+=================== =========================== ======================================================
 **Common properties**
------------------------------------------------------------------------------------------
- volume_transmitter NodeCollection volume_transmitter collecting the spikes from the
-                                   pool of dopamine releasing neurons and transmitting
-                                   the spikes to the synapse.
- A_plus              real          Multiplier applied to weight changes caused by
-                                   pre-before-post spike pairings. If b (dopamine
-                                   baseline concentration) is zero, then A_plus
-                                   is simply the multiplier for facilitation (as in the
-                                   stdp_synapse model). If b is not zero, then A_plus
-                                   will be the multiplier for facilitation only if n - b
-                                   is positive, where n is the instantenous dopamine
-                                   concentration in the volume transmitter. If n - b is
-                                   negative, A_plus will be the multiplier for
-                                   depression.
- A_minus             real          Multiplier applied to weight changes caused by
-                                   post-before-pre spike pairings. If b (dopamine
-                                   baseline concentration) is zero, then A_minus
-                                   is simply the multiplier for depression (as in the
-                                   stdp_synapse model). If b is not zero, then A_minus
-                                   will be the multiplier for depression only if n - b
-                                   is positive, where n is the instantenous dopamine
-                                   concentration in the volume transmitter. If n - b is
-                                   negative, A_minus will be the multiplier for
-                                   facilitation.
- tau_plus            ms            STDP time constant for weight changes caused by
-                                   pre-before-post spike pairings.
- tau_c               ms            Time constant of eligibility trace
- tau_n               ms            Time constant of dopaminergic trace
- b                   real          Dopaminergic baseline concentration
- Wmin                real          Minimal synaptic weight
- Wmax                real          Maximal synaptic weight
-=================== ============== ======================================================
+------------------------------------------------------------------------------------------------------
+ volume_transmitter :py:class:`.NodeCollection` :ref:`Volume transmitter <volume_transmitter>`
+                                                collecting the spikes from the pool of dopamine
+                                                releasing neurons and transmitting the spikes to the
+                                                synapse.
+ A_plus              real                       Multiplier applied to weight changes caused by
+                                                pre-before-post spike pairings. If b (dopamine
+                                                baseline concentration) is zero, then A_plus
+                                                is simply the multiplier for facilitation (as in the
+                                                stdp_synapse model). If b is not zero, then A_plus
+                                                will be the multiplier for facilitation only if n - b
+                                                is positive, where n is the instantenous dopamine
+                                                concentration in the volume transmitter. If n - b is
+                                                negative, A_plus will be the multiplier for
+                                                depression.
+ A_minus             real                       Multiplier applied to weight changes caused by
+                                                post-before-pre spike pairings. If b (dopamine
+                                                baseline concentration) is zero, then A_minus
+                                                is simply the multiplier for depression (as in the
+                                                stdp_synapse model). If b is not zero, then A_minus
+                                                will be the multiplier for depression only if n - b
+                                                is positive, where n is the instantenous dopamine
+                                                concentration in the volume transmitter. If n - b is
+                                                negative, A_minus will be the multiplier for
+                                                facilitation.
+ tau_plus            ms                         STDP time constant for weight changes caused by
+                                                pre-before-post spike pairings.
+ tau_c               ms                         Time constant of eligibility trace
+ tau_n               ms                         Time constant of dopaminergic trace
+ b                   real                       Dopaminergic baseline concentration
+ Wmin                real                       Minimal synaptic weight
+ Wmax                real                       Maximal synaptic weight
+=================== =========================== ======================================================
 
 The common properties can only be set by :py:func:`.SetDefaults` and apply
 to all instances of the synapse model.

models/volume_transmitter.h

@@ -71,6 +71,12 @@ dictionary and ``d_min`` is the minimal synaptic delay.
 
 The implementation is based on the framework presented in [1]_.
 
+Please note that the ``volume_transmitter`` property of a synapse can
+only be set by means of :py:func:`.CopyModel` or
+:py:func:`.SetDefaults`; setting the property inside of a
+:py:func:`.Connect` call is not supported for technical reasons.
+
+
 Parameters
 ++++++++++