docs(convert): note how __main__ guards are rewritten#10286
Closed
Bartok9 wants to merge 1 commit into
Closed
Conversation
Document that plain-script conversion rewrites top-level main-guards into helpers, and that string/comment occurrences are ignored. Complements the AST-based convert fix.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
the
documentation
Author
|
I have read the CLA Document and I hereby sign the CLA |
Member
|
This may change with #10237 |
Author
|
Good call, @dmadisetti — this doc note is tied to the rewrite behavior in #10237, so I'll close this too and let @vidigoat's PR land first. Happy to revisit the docs once the final behavior is settled. Thanks! |
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
2 participants
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.
This pull request was authored by a coding agent.
AI-assisted; human-reviewed.
Summary
When converting plain Python scripts, marimo rewrites a top-level
if __name__ == \"__main__\":into a_main_()helper. This adds a short notein the Jupyter migration guide so that behavior (and the string/comment
non-match rule) is not a surprise after
marimo convert.Docs only. Complements salvage #10284.
Checklist