Document name-redefinition and setup-cell constraints#55
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the marimo-pair skill documentation to reduce common notebook authoring errors, specifically around public name redefinition across cells and constraints of the setup cell.
Changes:
- Added explicit guidance that each public name should be defined in exactly one owning cell (with a pointer to gotchas).
- Documented
setupcell constraints (must be self-contained; cannot reference names defined in other cells) and clarified how to modify an existing setup cell. - Expanded
gotchas.mdwith a dedicated section on cross-cell name redefinition and updated the references list description.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| skills/marimo-pair/SKILL.md | Adds an explicit “define each public name once” rule and updates the gotchas reference blurb. |
| skills/marimo-pair/reference/notebook-improvements.md | Adds setup-cell constraints and clarifies how to handle an already-existing setup cell. |
| skills/marimo-pair/reference/gotchas.md | Adds a new gotcha section explaining public name redefinition failures and how to resolve them. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
48
to
49
| **Fix:** Use a `_` prefix on the second import (`import pandas as _pd`) or | ||
| consolidate imports into a shared cell. |
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.
Closes #47