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

[Feature]: Warn when using positional arguments in container constructors #1968

Open
3 tasks done
rly opened this issue Oct 3, 2024 · 0 comments · Fixed by #1972
Open
3 tasks done

[Feature]: Warn when using positional arguments in container constructors #1968

rly opened this issue Oct 3, 2024 · 0 comments · Fixed by #1972
Assignees
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users
Milestone

Comments

@rly
Copy link
Contributor

rly commented Oct 3, 2024

What would you like to see added to PyNWB?

To better support changes in NWB Container constructor arguments (e.g., #954), we would like to start the process toward not allowing the user to pass positional arguments to Container constructor methods. We added the ability to define a constructor arg docval with a flag to warn when using positional arguments and a flag to raise an error when using positional arguments. These are not currently used. The warning is already in place in HDMF common objects, like DynamicTable.

Is your feature request related to a problem?

No response

What solution would you like?

Phase 1 (PyNWB 3.0, this year): Warn when using positional arguments for all Container constructor arguments
Phase 2 (PyNWB 4.0, next year) Raise error when using positional arguments for all Container constructor arguments

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

@rly rly added this to the 3.0 milestone Oct 3, 2024
@stephprince stephprince added category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants