iodata icon indicating copy to clipboard operation
iodata copied to clipboard

Rename functions in `iodata.formats` submodules (?)

Open tovrstra opened this issue 1 year ago • 4 comments

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 avatar Jul 09 '24 16:07 tovrstra

hello @tovrstra can i work on this??

Puriva avatar Sep 27 '25 07:09 Puriva

Sure! That would be great. I'm happy to review your PR. (My teaching schedule is a bit dense at the moment, but I should be able to review.)

tovrstra avatar Sep 28 '25 14:09 tovrstra

thnks.i will try my best

Puriva avatar Sep 28 '25 14:09 Puriva

hi, is this issue still up ? i am looking for a good first issue, also what is the expected update required.

ashutoshsao avatar Dec 08 '25 08:12 ashutoshsao