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

Rename ae_bundle_streamline to ae_finta_multibundle and ae_generate_streamlines to ae_gesta_fast #47

Open
fdumais opened this issue Feb 13, 2023 · 1 comment

Comments

@fdumais
Copy link

fdumais commented Feb 13, 2023

No description provided.

@fdumais fdumais changed the title Rename ae_bundle_streamline to ae_finta_multibundle and ae_generate_streamlines to ae_gesta_fast and Rename ae_bundle_streamline to ae_finta_multibundle and ae_generate_streamlines to ae_gesta_fast Feb 13, 2023
@jhlegarreta
Copy link
Contributor

I do not think naming the scripts or functions with acronyms is a good idea: the script/function naming should be descriptive of their aim. The underlying method would be documented in the script/function docstring.

Naming is hard, but I think we can come up with something that provides a sufficient/accurate idea of the purpose and method used.

If the idea is to distinguish between FINTA/CINTA and FINTA-m, or GESTA and GESTA-f, ideally, IMO, if doable with reasonable effort and unless the methods are radically different that this is not doable (which I'd say it is not the case), the script should be designed to support both, and the user would choose with an e.g. enum which method they are willing to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants