Add FAQ entry about edit() returning immediately - #3780
Open
kdeldycke wants to merge 1 commit into
Open
Conversation
kdeldycke
force-pushed
the
spawned-editor-faq
branch
from
August 19, 2026 05:40
1efd23c to
9cd2758
Compare
kdeldycke
added
windows
kdeldycke
force-pushed
the
spawned-editor-faq
branch
from
August 19, 2026 05:47
9cd2758 to
e03ce61
Compare
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
1 participant
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 explain why some editors are returning immediately and does not respect the contract of the
edit()utility.Also added a warning admonition to the
edit()docstring itself so developers relying on it get informed about the limitations.Closes #2582.