Add warnings when using positional arguments in container constructors

[stephprince]

Motivation

Fix #1968. Add warnings to Container constructor methods when using positional arguments.

TODO

• change PR target to merge into 3.0.0 branch for upcoming major release

How to test the behavior?

from pynwb import TimeSeries

TimeSeries('name', [10, 11, 12, 13], 'V', timestamps=[0, 1, 2, 3])

Output:

<stdin>:1: FutureWarning: TimeSeries.__init__: Using positional arguments for this method is discouraged and will be deprecated in a future major release. Please use keyword arguments to ensure future compatibility.

Checklist

• Did you update CHANGELOG.md with your changes?
• Have you checked our Contributing document?
• Have you ensured the PR clearly describes the problem and the solution?
• Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
• Have you checked to ensure that there aren't other open Pull Requests for the same change?
• Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release-3.0.0@56d783c). Learn more about missing BASE report.

Additional details and impacted files

@@               Coverage Diff                @@
##             release-3.0.0    #1972   +/-   ##
================================================
  Coverage                 ?   91.86%           
================================================
  Files                    ?       27           
  Lines                    ?     2692           
  Branches                 ?      703           
================================================
  Hits                     ?     2473           
  Misses                   ?      145           
  Partials                 ?       74           

Flag	Coverage Δ
integration	72.65% <83.33%> (?)
unit	83.32% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.