Rename functions in `iodata.formats` submodules (?)
@Puriva is already working on this.
Since Sep 28, 2025.
Assessment
This issue has not been assessed yet.
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.)
- Dominant language
- Python
- Stars
- 171
- Forks
- 58
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from theochem/iodata
-
MOKitOpen
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Support TrexIOPossibly taken @dhruvDev23 claimed this 316 days ago. Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Error loading .wfx file created by OrcaPossibly taken @xovishnukosuri claimed this 223 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
JSON QCSchema updateOpen
Difficulty 5/5 Over a week Newbie friendliness 25/100
Similar issues
-
Python Volcengine provider returns failures instead of raising themPossibly taken @Ricardo-M-L claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
agent-infra/sandbox#248 ·
-
Textractor leaves empty temporary files when remote retrieval failsPossibly taken @HuaTNA claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
test(bm_generation): pin the learning parameters and CPU sync shortcutPossibly taken @iloveeyjafjalla claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
qboson/kaiwu-pytorch-plugin#1341 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
elder-plinius/V3R1T4S#625 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
foxglove/mcap#1907 · 1 comment ·
Maintainers usually reply within 1 day