pynwb icon indicating copy to clipboard operation
pynwb copied to clipboard

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

Open rly opened this issue 1 year ago • 0 comments

What would you like to see added to PyNWB?

To better support changes in NWB Container constructor arguments (e.g., https://github.com/NeurodataWithoutBorders/pynwb/issues/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 avatar Oct 03 '24 20:10 rly