Skip to content
New issue

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

#

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

Already on GitHub? # to your account

docs: correct a typo in the usage doc #69

Merged
merged 1 commit into from
Jan 8, 2024
Merged

docs: correct a typo in the usage doc #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ Usage

The :py:func:`copie <pytest_copie.plugin.copie>` fixture will allow you to :py:meth:`copy <pytest_copie.plugin.Copy.copy>` a template and run tests against it. It will also clean up the generated project after the tests have been run.

For these examples, let's assume the current folder is a copier template. it should include a ``copier.yml`` file and a ``{{repo_name}}`` folder containing jinja templates.
For these examples, let's assume the current folder is a copier template. it should include a ``copier.yml`` file and a ``template`` folder containing jinja templates.

.. note::

The name of the templlate folder can be anything as long as it matches the ``_subdirectory`` key in the ``copier.yml`` file.

.. code-block::

Expand Down