docs: Clarify custom column keyword arguments in ecephys tutorial#2176
Open
docs: Clarify custom column keyword arguments in ecephys tutorial#2176
Conversation
…s tutorial Agent-Logs-Url: https://github.com/NeurodataWithoutBorders/pynwb/sessions/91934ae7-7b58-4b2f-b11a-62756f3f2ad7 Co-authored-by: rly <310197+rly@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Remove label key in add_electrode function documentation
docs: Clarify custom column keyword arguments in ecephys tutorial
Mar 27, 2026
rly
approved these changes
Mar 27, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #2176 +/- ##
=======================================
Coverage 95.10% 95.10%
=======================================
Files 29 29
Lines 2943 2943
Branches 443 443
=======================================
Hits 2799 2799
Misses 86 86
Partials 58 58
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
rly
reviewed
Mar 27, 2026
rly
reviewed
Mar 27, 2026
Co-authored-by: Ryan Ly <310197+rly@users.noreply.github.com>
rly
reviewed
Mar 27, 2026
rly
reviewed
Mar 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix #2093. Users are confused by
labelinnwbfile.add_electrode(label=...)thinking it's a built-in parameter, when it's actually a custom column defined earlier viaadd_electrode_column. The same ambiguity exists forqualityinadd_unit.Changes
docs/gallery/domain/ecephys.py: Added inline comments toadd_electrodeandadd_unitcalls clarifying that custom column values are passed as keyword arguments:⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.