-
Notifications
You must be signed in to change notification settings - Fork 7
Minor fixes in Documentation #21
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: ashiscs <ashissingh640@gmail.com>
@CermakM sir, please review.. |
README.rst
Outdated
@@ -11,21 +11,21 @@ About | |||
|
|||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
README.rst
Outdated
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
README.rst
Outdated
|
||
| | ||
|
||
What is this for? | ||
================= | ||
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
@@ -77,7 +77,7 @@ To install the nbextension itself and enable it, we have supplied a helper funct | |||
utils.load_nbextension('jupyter-require', enable=True) | |||
|
|||
|
|||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
||
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**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
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**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a typo.
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
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".. |
I think sir, it is ready to be merged if any change is required i will do it. |
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 <ashissingh640@gmail.com>
@CermakM sir, did the required changes |
Signed-off-by: ashiscs ashissingh640@gmail.com