SpiNNakerManchester / sPyNNaker

The SpiNNaker implementation of the PyNN neural networking language
Apache License 2.0
103 stars 43 forks source link

SynapseDynamicsStructuralSTD f_rew docs mismatch #834

Open alan-stokes opened 4 years ago

alan-stokes commented 4 years ago

The issue arises from @dkfellows trying to add docs to these classes. Unfortunately there is a mismatch that @pabogdan will likely be able to solve in no time.

the common class says the r_rew is a int: https://github.com/SpiNNakerManchester/sPyNNaker/blob/master/spynnaker/pyNN/models/neuron/synapse_dynamics/synapse_dynamics_structural_common.py#L102

and the default value is a int from here: https://github.com/SpiNNakerManchester/sPyNNaker/blob/master/spynnaker/pyNN/models/neuron/synapse_dynamics/synapse_dynamics_structural_common.py#L88

but the other class says its a float. from here: https://github.com/SpiNNakerManchester/sPyNNaker/blob/graph-mapping-sanity/spynnaker/pyNN/models/neuron/synapse_dynamics/abstract_synapse_dynamics_structural.py#L76

more of, i cant see where this is used, but to create another p_rew. which begs the question, why isnt f_rew just p_rew in the first place?

Christian-B commented 3 years ago

in hindsite it may not have been needed to have both f_rew and p_rew but not worth an api change.