This repository was archived by the owner on May 3, 2020. It is now read-only.
Minor fixes in Documentation #21
Open
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
Signed-off-by: ashiscs <[email protected]>
Author
|
@CermakM sir, please review.. |
CermakM
suggested changes
Apr 8, 2020
README.rst
Outdated
| The `jupyter-require`_ library is intended to be used in `Jupyter`_ notebooks. | ||
|
|
||
| Jupyter-require allows to execute and manage custom `JavaScript`_ and `CSS`_ files and even create and load your own styles and scripts directly from `Jupyter`_ notebook. | ||
| Jupyter-require allows us to execute and manage custom `JavaScript`_ and `CSS`_ files and even create and load your styles and scripts directly from `Jupyter`_ notebook. |
README.rst
Outdated
| Jupyter-require allows us to execute and manage custom `JavaScript`_ and `CSS`_ files and even create and load your styles and scripts directly from `Jupyter`_ notebook. | ||
|
|
||
| Jupyter-require provides a unique opportunity to customize Jupyter notebooks and enables users to handcraft their own JavaScript-augmented workflows while keeping in mind synchronicity demands and security implications of such approaches. | ||
| Jupyter-require provides a unique opportunity to customize Jupyter notebooks and enables users to handcraft their JavaScript-augmented workflows while keeping in mind synchronicity demands and security implications of such approaches. |
README.rst
Outdated
| ================= | ||
|
|
||
| Let's demonstrate the usage on an example. Note that the usage is limited only by your imagination, this is just a demonstration of a single use case. | ||
| Let's demonstrate the usage of an example. Note that the usage is limited only by your imagination, this is just a demonstration of a single-use case. |
README.rst
Outdated
| If you are into data visualization like me, you've most likely already heard of `d3`_.js JavaScript ecosystem. | ||
| It's an incredibly powerful tool which can be used to create advanced interactive visualizations. | ||
| It's an incredibly powerful tool that can be used to create advanced interactive visualizations. |
| All of that above can be done from command line, so if you're used to installing nbextensions the regular way, feel free to do so. In fact, you are **recommended** to, this approach is just for lazy people like myself. | ||
| All of that above can be done from the command line, so if you're used to installing nbextensions the regular way, feel free to do so. In fact, you are **recommended** to, this approach is just for lazy people like myself. |
| ⚠️ The notion of safe scripts is something that has been added pretty recently and is under heavy observation. | ||
|
|
||
| By the word *safe* we don't refer to an execution which reduces security threats, no, nothing like that. It is *YOU* who guarantee that the script *is* safe and can be treated as such. | ||
| The mechanism which we treat *safe scripts* by is very similar to the one described above, with one important change: safe scripts are similar to the default Jupyter notebook behaviour in a sense that they are also **executed on the notebook reload** and are also **stored in the resulting `*.ipynb` notebook file**. |
README.rst
Outdated
|
|
||
| By the word *safe* we don't refer to an execution which reduces security threats, no, nothing like that. It is *YOU* who guarantee that the script *is* safe and can be treated as such. | ||
| The mechanism which we treat *safe scripts* by is very similar to the one described above, with one important change: safe scripts are similar to the default Jupyter notebook behaviour in a sense that they are also **executed on the notebook reload** and are also **stored in the resulting `*.ipynb` notebook file**. | ||
| By the word *safe*, we don't refer to an execution that reduces security threats, no, nothing like that. It is *YOU* who guarantee that the script *is* safe and can be treated as such. |
README.rst
Outdated
| By the word *safe* we don't refer to an execution which reduces security threats, no, nothing like that. It is *YOU* who guarantee that the script *is* safe and can be treated as such. | ||
| The mechanism which we treat *safe scripts* by is very similar to the one described above, with one important change: safe scripts are similar to the default Jupyter notebook behaviour in a sense that they are also **executed on the notebook reload** and are also **stored in the resulting `*.ipynb` notebook file**. | ||
| By the word *safe*, we don't refer to an execution that reduces security threats, no, nothing like that. It is *YOU* who guarantee that the script *is* safe and can be treated as such. | ||
| The mechanism which we treat *safe scripts* by is very similar to the one described above, with one important change: safe scripts are similar to the default Jupyter notebook behavior in a sense that they are also **executed on the notebook reload** and are also **stored in the resulting `*.ipynb` notebook file**. |
| The mechanism which we treat *safe scripts* by is very similar to the one described above, with one important change: safe scripts are similar to the default Jupyter notebook behavior in a sense that they are also **executed on the notebook reload** and are also **stored in the resulting `*.ipynb` notebook file**. | ||
|
|
||
| Hence you can enjoy the benefits of a sandbox(ish) synchronous execution while still having the scripts stored in the output. The one **limitation** is that they do not allow to specify requirements as the ``execute_with_requirements`` function does by its ``required`` parameter. This is because those scripts can be executed *before* extensions are actually loaded and we can not guarantee (at least we don't know how right now) that the functionality of jupyter-require will be present at that time. | ||
| Hence you can enjoy the benefits of a sandbox(ish) synchronous execution while still having the scripts stored in the output. The one **limitation** is that they do not allow to specify requirements as the *execute_with_requirements* function does by its ``required`` parameter. This is because those scripts can be executed *before* extensions are loaded and we can not guarantee (at least we don't know how right now) that the functionality of jupyter-require will be present at that time. |
| Hence you can enjoy the benefits of a sandbox(ish) synchronous execution while still having the scripts stored in the output. The one **limitation** is that they do not allow to specify requirements as the *execute_with_requirements* function does by its ``required`` parameter. This is because those scripts can be executed *before* extensions are loaded and we can not guarantee (at least we don't know how right now) that the functionality of jupyter-require will be present at that time. | ||
|
|
||
| To treat your script as *safe script*, execute it with ``safe_execute`` function. | ||
| To treat your script as a *safe script*, execute it with ``safe_execute`` function. |
Author
|
Yes sir @CermakM some of them were not typo though but as some typo were also present so i summed the title as "fixed the typos".. |
Author
|
I think sir, it is ready to be merged if any change is required i will do it. |
Owner
|
The changes marked as "Not a typo" are not errors, for those cases, the fix is invalid and should be reverted. |
Signed-off-by: ashiscs <[email protected]>
Author
|
@CermakM sir, did the required changes |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: ashiscs [email protected]