Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make function signatures more consistent #94

Open
schlegelp opened this issue May 4, 2022 · 0 comments
Open

Make function signatures more consistent #94

schlegelp opened this issue May 4, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@schlegelp
Copy link
Collaborator

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) and ret (navis.cut_skeleton) to determine the return value
  • filenames/filepaths can be f or filepath
  • MeshNeurons are constructed from (vertices, faces) tuple whereas Volumes take vertices, faces
  • many functions use x as first positional argument regardless of whether that can be skeletons, meshes, dotprops or a combination thereof
@schlegelp schlegelp added the enhancement New feature or request label May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant