From e1e7e896d53f24e35b3715b083e8137bbac191bc Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Thu, 30 Aug 2018 11:27:56 -0700 Subject: [PATCH] A couple of typos --- docs/source/architecture.rst | 2 +- docs/source/nbconvert_library.ipynb | 8 ++++---- nbconvert/preprocessors/base.py | 2 +- nbconvert/templates/latex/base.tplx | 2 +- nbconvert/tests/test_nbconvertapp.py | 4 ++-- nbconvert/writers/debug.py | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index 209b14307..0305d1f98 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -17,7 +17,7 @@ A detailed pipeline exploration Nbconvert takes in a notebook, which is a JSON object, and operates on that object. This can include operations that take a notebook and return a notebook. -For example, that operation could be to execute the notebook as though it were a continuous script; if it were executed ``--in-place`` then it would overwite the current notebook. +For example, that operation could be to execute the notebook as though it were a continuous script; if it were executed ``--in-place`` then it would overwrite the current notebook. Or it could be that we wish to systematically alter the notebook, for example by clearing all output cells. Format agnostic operations on cell content that do not violate the nbformat spec can be interpreted as a notebook to notebook conversion step; such operations can be performed as part of the preprocessing step. diff --git a/docs/source/nbconvert_library.ipynb b/docs/source/nbconvert_library.ipynb index 6c98d1d26..2928c5841 100644 --- a/docs/source/nbconvert_library.ipynb +++ b/docs/source/nbconvert_library.ipynb @@ -167,7 +167,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "If you understand HTML, you'll notice that some common tags are ommited, like the `body` tag. Those tags are included in the default `HtmlExporter`, which is what would have been constructed if we had not modified the `template_file`.\n", + "If you understand HTML, you'll notice that some common tags are omitted, like the `body` tag. Those tags are included in the default `HtmlExporter`, which is what would have been constructed if we had not modified the `template_file`.\n", "\n", "The resource dict contains (among many things) the extracted `.png`, `.jpg`, etc. from the notebook when applicable. The basic HTML exporter leaves the figures as embedded base64, but you can configure it to extract the figures. So for now, the resource dict should be mostly empty, except for a key containing CSS and a few others whose content will be obvious:" ] @@ -303,7 +303,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Notice that base64 images are not embeded, but instead there are filename-like strings, such as `output_3_0.png`. The strings actually are (configurable) keys that map to the binary data in the resources dict.\n", + "Notice that base64 images are not embedded, but instead there are filename-like strings, such as `output_3_0.png`. The strings actually are (configurable) keys that map to the binary data in the resources dict.\n", "\n", "Note, if you write an RST Plugin, you are responsible for writing all the files to the disk (or uploading, etc...) in the right location. Of course, the naming scheme is configurable.\n", "\n", @@ -599,7 +599,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Programatically creating templates" + "## Programmatically creating templates" ] }, { @@ -650,7 +650,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "@jakevdp uses Pelican and Jupyter Notebook to blog. Pelican [will use](https://github.com/getpelican/pelican-plugins/pull/21) nbconvert programatically to generate blog post. Have a look a [Pythonic Preambulations](http://jakevdp.github.io/) for Jake's blog post." + "@jakevdp uses Pelican and Jupyter Notebook to blog. Pelican [will use](https://github.com/getpelican/pelican-plugins/pull/21) nbconvert programmatically to generate blog post. Have a look a [Pythonic Preambulations](http://jakevdp.github.io/) for Jake's blog post." ] }, { diff --git a/nbconvert/preprocessors/base.py b/nbconvert/preprocessors/base.py index f962ff5af..3a0a3feb0 100755 --- a/nbconvert/preprocessors/base.py +++ b/nbconvert/preprocessors/base.py @@ -18,7 +18,7 @@ class Preprocessor(NbConvertBase): you can overwrite :meth:`preprocess_cell` to apply a transformation independently on each cell or :meth:`preprocess` if you prefer your own - logic. See corresponding docstring for informations. + logic. See corresponding docstring for information. Disabled by default and can be enabled via the config by 'c.YourPreprocessorName.enabled = True' diff --git a/nbconvert/templates/latex/base.tplx b/nbconvert/templates/latex/base.tplx index f92727906..1fb5d8889 100644 --- a/nbconvert/templates/latex/base.tplx +++ b/nbconvert/templates/latex/base.tplx @@ -138,7 +138,7 @@ This template does not define a docclass, the inheriting class must define this. % Define a nice break command that doesn't care if a line doesn't already % exist. \def\br{\hspace*{\fill} \\* } - % Math Jax compatability definitions + % Math Jax compatibility definitions \def\gt{>} \def\lt{<} \let\Oldtex\TeX diff --git a/nbconvert/tests/test_nbconvertapp.py b/nbconvert/tests/test_nbconvertapp.py index 38f02bdc7..7ec239587 100644 --- a/nbconvert/tests/test_nbconvertapp.py +++ b/nbconvert/tests/test_nbconvertapp.py @@ -230,7 +230,7 @@ def test_default_config(self): def test_override_config(self): """ - Can the default config be overriden? + Can the default config be overridden? """ with self.create_temp_cwd(['notebook*.ipynb', 'jupyter_nbconvert_config.py', @@ -425,7 +425,7 @@ def test_embedded_jpeg(self): @onlyif_cmds_exist('pandoc') def test_markdown_display_priority(self): """ - Check to see if markdown conversion embedds PNGs, + Check to see if markdown conversion embeds PNGs, even if an (unsupported) PDF is present. """ with self.create_temp_cwd(['markdown_display_priority.ipynb']): diff --git a/nbconvert/writers/debug.py b/nbconvert/writers/debug.py index 85cc24b6f..43d72bc29 100644 --- a/nbconvert/writers/debug.py +++ b/nbconvert/writers/debug.py @@ -22,7 +22,7 @@ #----------------------------------------------------------------------------- class DebugWriter(WriterBase): - """Consumes output from nbconvert export...() methods and writes usefull + """Consumes output from nbconvert export...() methods and writes useful debugging information to the stdout. The information includes a list of resources that were extracted from the notebook(s) during export."""