diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ec0bf8..094565f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,13 +7,21 @@ and this project strives to adhere to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +### [0.1.post1] - 2022-04-11 + +#### Administrative + +- Fix semantic error in README.md regarding variable restoration behavior + after code cell execution (variables *are* restored by default) + + ### [0.1] - 2022-04-06 #### Features - * Per-cell temporary variable filtering based on starts-with and ends-with - filters. - * `pip`-installable packaging for PyPI upload using the recent - PEP621 `pyproject.toml` project config for `setuptools`. - * Includes a helper script to simplify installation/upgrade of the - extension files to the user-space Jupyter extension location. +- Per-cell temporary variable filtering based on starts-with and ends-with + filters. +- `pip`-installable packaging for PyPI upload using the recent + PEP621 `pyproject.toml` project config for `setuptools`. +- Includes a helper script to simplify installation/upgrade of the + extension files to the user-space Jupyter extension location. diff --git a/README.md b/README.md index d5257fe..27507ac 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,10 @@ as temporary variables. This means that: finished executing, ensuring that other code cells aren't contaminated by this cell, either. +As `jupyter-tempvars` is currently configured, any variables removed +from the global namespace before execution of the cell are *restored* +to the global namespace after execution is finished. + ## Prerequisites @@ -109,7 +113,7 @@ or by running the helper script with the `enable` command: $ jupyter-tempvars enable ``` -Note that the `jupyter-tempvars` helper script is set up to install the extension +Again, note that the `jupyter-tempvars` helper script is set up to install the extension to the user's Jupyter extension repository (`--user` flag to `jupyter nbextension`). If you wish to install to a different location, you'll need to invoke the necessary `jupyter nbextension` commands manually. @@ -185,9 +189,10 @@ echoed to output for tagged cells, and must be explicitly `print`-ed: Animation demonstrating suppression of output -The underlying `tempvars` library has the capability to restore pre-existing temporary variables, -cleared before the start of tagged cell execution, back to the global namespace -after execution has completed. If this feature would be of interest for `jupyter-tempvars`, +As noted above, `jupyter-tempvars` currently restores pre-existing temporary variables, +cleared before the start of tagged cell execution, *back* to the global namespace +after execution has completed. If it would be valuable to allow the option of +*not* restoring the pre-existing variables after execution of a tagged cell, please comment [here](https://github.com/bskinn/jupyter-tempvars/issues/21). More generally, bug reports and feature requests of any kind for both [`jupyter-tempvars`](https://github.com/bskinn/jupyter-tempvars/issues) and the underlying @@ -221,5 +226,5 @@ Bug reports and feature requests are welcomed at the Copyright (c) Brian Skinn 2022 License: The MIT License. See -[LICENSE.txt](https://github.com/bskinn/sphobjinv/blob/main/LICENSE.txt) +[LICENSE.txt](https://github.com/bskinn/jupyter-tempvars/blob/main/LICENSE.txt) for full license terms. diff --git a/src/jupyter_tempvars/version.py b/src/jupyter_tempvars/version.py index 72b2555..0dd166b 100644 --- a/src/jupyter_tempvars/version.py +++ b/src/jupyter_tempvars/version.py @@ -25,4 +25,4 @@ """ -__version__ = "0.1" +__version__ = "0.1.post1"