DOC: Add documentation about current getters support #696
Conversation
This file contains 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
bnmajor
force-pushed
the
getters-docs
branch
from
063b1aa to
694d0da
Compare
bnmajor
force-pushed
the
getters-docs
branch
from
694d0da to
d9d9199
Compare
thewtex
reviewed
Nov 30, 2023
docs/advanced.md
Outdated
|
|
||
| ## Returning Values | ||
|
|
||
| Communication with the IPython Kernel is asynchronous, which means that running Python code blocks any comm messages until the Python code is done. With regards to ITKWidgets this means that getter functions do not "just work" - the Python code cannot complete until the comm message has resolved with the response and the message cannot resolve until the code has completed. This creates a deadlock that prevents the kernel from progressing. This has been a [documented issue](https://github.com/ipython/ipykernel/issues/65) for many years. |
There was a problem hiding this comment.
perhaps:
which means that running Python code blocks any comm messages
->
which causes challenges with Python code blocks in Jupyter cells that run synchronously. Multiple comm messages cannot be awaited during the synchronous Python code block execution.
| ## Returning Values | ||
|
|
||
| Communication with the IPython Kernel is asynchronous, which means that running Python code blocks any comm messages until the Python code is done. With regards to ITKWidgets this means that getter functions do not "just work" - the Python code cannot complete until the comm message has resolved with the response and the message cannot resolve until the code has completed. This creates a deadlock that prevents the kernel from progressing. This has been a [documented issue](https://github.com/ipython/ipykernel/issues/65) for many years. | ||
|
|
There was a problem hiding this comment.
documented issue
-> documented issue for the Jupyter ipykernel
|
@thewtex Fantastic, thanks! Changes have been made. |
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.
No description provided.