search

arbor-sim / arbor

The Arbor multi-compartment neural network simulation library.
https://arbor-sim.org
BSD 3-Clause "New" or "Revised" License
108 stars 61 forks source link

Docs reference `arbor.ion` which does not exist. #2253

Closed Helveg closed 3 months ago

Helveg commented 8 months ago

Describe the bug Latest docs with latest arbor (60445a) says that ion species can be painted locally using arbor.ion but this doesn't exist.

https://docs.arbor-sim.org/en/latest/concepts/decor.html#ion-species

None of the decor.paint syntaxes in the 3 code snippets is correct, and the correct now seems to be:

decor.paint('(tag 2)', ion="ca", diff=42*arbor.units.m2/arbor.units.s)