ElectrodesTable

[mavaylon1]

Motivation

What was the reasoning behind this change? Please explain the changes briefly.

How to test the behavior?

Show how to reproduce the new behavior (can be a bug fix or a new feature)

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 flake8 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

Attention: Patch coverage is 81.25000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 82.58%. Comparing base (01d9ab9) to head (5785f75).

Files with missing lines	Patch %	Lines
src/pynwb/io/file.py	58.33%	4 Missing and 1 partial ⚠️
src/pynwb/file.py	75.00%	1 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (01d9ab9) and HEAD (5785f75). Click for more details.

HEAD has 13 uploads less than BASE

Flag	BASE (01d9ab9)	HEAD (5785f75)
unit	8	3
integration	8	0

Additional details and impacted files

@@             Coverage Diff             @@
##              dev    #1890       +/-   ##
===========================================
- Coverage   92.84%   82.58%   -10.26%     
===========================================
  Files          28       28               
  Lines        2755     2780       +25     
  Branches      716      721        +5     
===========================================
- Hits         2558     2296      -262     
- Misses        127      384      +257     
- Partials       70      100       +30     

Flag	Coverage Δ
integration	?
unit	82.58% <81.25%> (-0.17%)	⬇️

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.

[mavaylon1]

@rly This is at the point where everything works on my end, I added some notes for future reference, and should be good to go. Let me know what you think. Let's see if we can release the schema asap after merging the electrodes schema

[rly]

please bump to PyNWB 3.1.0 as this is a minor change, not a bug fix

[rly]

this will also be part of supporting NWB schema 2.9.0

[rly]

This might break downstream code. Hopefully not because people should not be using this function, but it is not conventionally marked as private with leading underscores, so they might. What do you think about changing this to something like:

def ElectrodeTable(name='electrodes', 
                   description='metadata about extracellular electrodes'):
    warn("The ElectrodeTable convenience function is deprecated. Please create a new instance of the ElectrodesTable class instead.", DeprecationWarning)
    return ElectrodesTable()