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 functions in iodata.formats submodules (?) #369

Open
tovrstra opened this issue Jul 9, 2024 · 0 comments
Open

Rename functions in iodata.formats submodules (?) #369

tovrstra opened this issue Jul 9, 2024 · 0 comments
Labels
API breaking Should be done first to stabilize API
Milestone

Comments

@tovrstra
Copy link
Member

tovrstra commented Jul 9, 2024

We use the same names in iodata.api as in the submodules of iodata.formats, e.g. iodata.formats.fcidump. For example, they both have load_one and dump_one. Yet, these functions have different APIs, which may be confusing. When the names are the same, one may easily assume they are completely compatible.

An example of this type of confusion can be found in #367.

We may clarify this be renaming the functions in the formats modules, to emphasize their difference in arguments. For example, load_one_fmt, dump_one_fmt, etc. (If we want this, we'd better do it before 1.0.0.)

@tovrstra tovrstra added the API breaking Should be done first to stabilize API label Jul 9, 2024
@tovrstra tovrstra added this to the 1.0.0 milestone Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API breaking Should be done first to stabilize API
Projects
None yet
Development

No branches or pull requests

1 participant