search

IBT-FMI / COSgen

Contrast Optimized Stimulation generator
GNU Lesser General Public License v3.0
1 stars 1 forks source link

Docstring clarification #4

Open TheChymera opened 7 years ago

TheChymera commented 7 years ago

  1. Could you please clarify the following section of the docstring? https://github.com/IBT-FMI/COSgen/blob/d68af52cb50e77ba6f476eeb0053618fa1d54805/cosgen/function_crate.py#L207-L211 I assume it's just a typo as/has --- but I still don't understand where a crossover function would be specified, and what it means to have it fixed to this function.

  2. https://github.com/IBT-FMI/COSgen/blob/d68af52cb50e77ba6f476eeb0053618fa1d54805/cosgen/models.py#L133-L135 This needs commas for the ennumeration, and *vectors has a typo, but most importantly: would linearly decaying time course not be a better description? Same here: https://github.com/IBT-FMI/COSgen/blob/d68af52cb50e77ba6f476eeb0053618fa1d54805/cosgen/models.py#L230-L232

  3. Unsure what cave means here: https://github.com/IBT-FMI/COSgen/blob/d68af52cb50e77ba6f476eeb0053618fa1d54805/cosgen/models.py#L456

faymanns commented 7 years ago

I think I fixed them all. Not sure if the first one is clear now: https://github.com/IBT-FMI/COSgen/blob/c9f980cd3271d3c57f9df16ecd462590eaac1859/cosgen/function_crate.py#L205-L211

TheChymera commented 7 years ago

Yes, it's still not very clear what is set to which function, and what being set means. Do you mean the argument is passed to another function? as a **keyword argument?