arbor icon indicating copy to clipboard operation
arbor copied to clipboard

Document return types for recipe method implementations

Open Helveg opened this issue 4 years ago • 2 comments

The API docs on recipe's at https://docs.arbor-sim.org/en/latest/python/recipe.html#arbor.recipe.cell_description list all the functions one should implement and describe in prose what each function is supposed to do. For most functions this is adequate information to piece things together, but could the rtype be added to each function? That would provide a direct link to each return type

Additionally, a link to a tutorial or code example implementing all these functions could be added in the head section https://docs.arbor-sim.org/en/latest/python/recipe.html#recipes

Helveg avatar May 28 '21 13:05 Helveg

@noraabiakar I guess the recipe.global_properties() issue I mentioned falls under this category of missing return type links. It also says kind in the argument list.

Helveg avatar Jun 18 '21 15:06 Helveg

Piling on here on the recipe methods: the docstring for probes(gid) is kind of dense and unclear, another good location for an example.

Helveg avatar Sep 08 '21 16:09 Helveg