Docs suggestions #426
Merged
Docs suggestions #426
Conversation
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
docs/kernels.rst
Outdated
| @@ -8,7 +8,7 @@ A 'kernel' is a program that runs and introspects the user's code. IPython | |||
| includes a kernel for Python code, and people have written kernels for | |||
| `several other languages <https://github.com/jupyter/jupyter/wiki/Jupyter-kernels>`_. | |||
|
|
|||
| When Jupyter starts a kernel, it passes it a connection file. This specifies | |||
| At startup, Jupyter passes the kernel a connection file. This specifies | |||
There was a problem hiding this comment.
I would state At kernel startup to disambiguate between Jupyter startup and kernel startup for readers.
There was a problem hiding this comment.
Thanks for the 👀 @captainsafia. I've made the suggested change
|
Thanks @ericdill and @captainsafia for the review! |
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.
Hi
jupyter-clientteam,During my read through of the docs, I came across a couple of spots that were ambiguous or a bit unclear. This PR aims to clarify a couple of those spots. Thanks for all the hard work on the documentation for jupyter-client. The docs are really amazing!