From b888fd4c17afc9b6993d9edec146d25d54930c8f Mon Sep 17 00:00:00 2001 From: Ryan Russell Date: Wed, 1 Jun 2022 16:14:58 -0500 Subject: [PATCH] Improve Docs Readability Signed-off-by: Ryan Russell --- docs/advanced/local_extensions.rst | 2 +- docs/advanced/template_extensions.rst | 2 +- docs/index.rst | 2 +- docs/overview.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/advanced/local_extensions.rst b/docs/advanced/local_extensions.rst index d7eba4603..a9eb0a3fa 100644 --- a/docs/advanced/local_extensions.rst +++ b/docs/advanced/local_extensions.rst @@ -32,7 +32,7 @@ This example uses a simple module ``local_extensions.py`` which exists in the te This will register the ``foobar`` filter for the template. -For many cases, this will be unneccessarily complicated. +For many cases, this will be unnecessarily complicated. It's likely that we'd only want to register a single function as a filter. For this, we can use the ``simple_filter`` decorator: .. code-block:: json diff --git a/docs/advanced/template_extensions.rst b/docs/advanced/template_extensions.rst index 397460fa8..3e10bf838 100644 --- a/docs/advanced/template_extensions.rst +++ b/docs/advanced/template_extensions.rst @@ -95,7 +95,7 @@ Would output: it-s-a-random-version -It is different from a mere replace of spaces since it also trates some special characters such as ``'`` in the example above. +It is different from a mere replace of spaces since it also treats some special characters differently such as ``'`` in the example above. The function accepts all arguments that can be passed to the ``slugify`` function of `python-slugify`_. For example to change the output from ``it-s-a-random-version``` to ``it_s_a_random_version``, the ``separator`` parameter would be passed: ``slugify(separator='_')``. diff --git a/docs/index.rst b/docs/index.rst index 14f5edbcf..7e82fc2db 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Cookiecutter: Better Project Templates ====================================== -Cookiecutter creates projects from **cookiecutters** (project templates), e.g. Python package projects from Python package temnplates. +Cookiecutter creates projects from **cookiecutters** (project templates), e.g. Python package projects from Python package templates. Basics ------ diff --git a/docs/overview.rst b/docs/overview.rst index 6a1895614..dd06999ef 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -5,7 +5,7 @@ Overview Cookiecutter takes a template provided as a directory structure with template-files. Templates can be in located in the filesystem, as a ZIP-file or on a VCS-Server (Git/Hg) like GitHub. -It reads a settings file and prompts the user interactivly wether to change the settings. +It reads a settings file and prompts the user interactively whether or not to change the settings. Then it takes both and generates an output directory structure from it.