Fix kernel hang when calling doc() or open()#282
Merged
Conversation
Override doc() and open() with inline alternatives that prevent the kernel from hanging in a headless environment. doc() now displays help text via help(), and open() displays the file path via which(). Adds regression tests with a timeout to detect the hang.
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.
Summary
Closes #184
@doc/doc.moverride: redirectsdoc <topic>tohelp <topic>, displaying documentation inline instead of launching a GUI browser@open/open.moverride: redirectsopen <fname>to display the file path viawhich(), instead of launching an editorqueue.EmptyTest plan
just test-kernelpasses (newtest_doc_does_not_hangandtest_open_does_not_hangtests)doc dispandopen dispreturn output inline in a Jupyter notebook without hanging