Rename functions in `iodata.formats` submodules (?)
Open
@Puriva is already working on this.
Since Sep 28, 2025.
API breaking
- Dominant language
- Python
- Stars
- 170
- Forks
- 57
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Description
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.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.