Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Docs Readability #1690

Merged
merged 1 commit into from
Jun 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced/local_extensions.rst
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/template_extensions.rst
Expand Up @@ -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='_')``.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -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
------
Expand Down
2 changes: 1 addition & 1 deletion docs/overview.rst
Expand Up @@ -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.

Expand Down