Skip to content

Commit

Permalink
Add note about stripping kernelspec to README #141
Browse files Browse the repository at this point in the history
  • Loading branch information
kynan committed Apr 11, 2021
1 parent 81d73f1 commit d4ed465
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,7 @@ Additional metadata to be stripped can be configured via either

git config --global filter.nbstripout.extrakeys '
metadata.celltoolbar
metadata.kernelspec.display_name
metadata.kernelspec.name
metadata.kernelspec
metadata.language_info.codemirror_mode.version
metadata.language_info.pygments_lexer
metadata.language_info.version
Expand All @@ -274,6 +273,11 @@ Additional metadata to be stripped can be configured via either

--extra-keys "metadata.celltoolbar cell.metadata.heading_collapsed"

Note: Previous versions of Jupyter used ``metadata.kernel_spec`` for kernel
metadata. Prefer stripping ``kernelspec`` entirely: only stripping some
attributes inside ``kernelspec`` may lead to errors when opening the notebook
in Jupyter (see `#141 <https://github.com/kynan/nbstripout/issues/141>`_).

Excluding files and folders
+++++++++++++++++++++++++++

Expand Down

0 comments on commit d4ed465

Please sign in to comment.