navis
navis copied to clipboard
Make function signatures more consistent
navis
has grown organically and I have spent only minimal thought on keeping things consistent across functions. For the next major version it would be nice if we could try levelling the playing field somewhat by making sure parameters with similar meaning always have the same name.
Some examples (will expand the list as I spot cases):
- functions use
output
(e.g.navis.read_nrrd
) andret
(navis.cut_skeleton
) to determine the return value - filenames/filepaths can be
f
orfilepath
-
MeshNeurons
are constructed from(vertices, faces)
tuple whereasVolumes
takevertices, faces
- many functions use
x
as first positional argument regardless of whether that can be skeletons, meshes, dotprops or a combination thereof