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

Make IO constructor signature consistent #1455

Open
apdavison opened this issue Apr 5, 2024 · 2 comments
Open

Make IO constructor signature consistent #1455

apdavison opened this issue Apr 5, 2024 · 2 comments
Milestone

Comments

@apdavison
Copy link
Member

apdavison commented Apr 5, 2024

Is your feature request related to a problem? Please describe.
Some IOs expect a single file name, others expect a single directory name, others expect a file basename, which is expanded to multiple file names with different extensions, others allow specifying files to include, others files to exclude from the listing in the directory.

This inconsistency is confusing.

Describe the solution you'd like
We should decide on a single policy for IO module constructors, and update IOs that don't conform (with a deprecation warning for the old keyword arguments for at least one 0.x release).

Additional context
See #1440 for an example of where not having a policy is a problem.

@apdavison apdavison added this to the 0.13.1 milestone Apr 5, 2024
@h-mayorquin
Copy link
Contributor

@CodyCBakerPhD @bendichter we were discussing this today at neuroconv meeting. It might be useful to follow this discussion and standarize the way we handle this across the ecosystem.

@zm711
Copy link
Contributor

zm711 commented May 3, 2024

I just want to say based on my struggle helping in #1338 this is again a problem of needing the right naming. In this case we looked for the dirname which was actually the filename and not a directory. I'll put this on my list to focus on for 14.0

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

No branches or pull requests

3 participants