Skip to content

Commit

Permalink
docs: fix spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
sisp authored and yajo committed Aug 26, 2022
1 parent 87f971f commit fc6bb03
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 38 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Summary:
- Raise a CopierAnswersInterrupt instead of a bare KeyboardInterrupt to provide
callers with additional context - such as the partially completed AnswersMap.
- Support for `user_defaults`, which take precedence over template defaults.
- Copy dirty changes from a git-tracked template to the project by default, to make
- Copy dirty changes from a Git-tracked template to the project by default, to make
testing easier.
- Advertise clearly which version is being copied or updated in the CLI.
- Add jinja variable `_copier_python` to provide python `sys.executable`.
- Add jinja variable `_copier_python` to provide Python `sys.executable`.

### Changed

Expand Down Expand Up @@ -93,7 +93,7 @@ Summary:
- A directory that gets an empty name works as expected: not copied (nor its
contents).
- When comparing versions to update, PEP 440 is always used now. This way, we avoid
fake ordering when git commit descriptions happen to be ordered in a non-predictable
fake ordering when Git commit descriptions happen to be ordered in a non-predictable
way.
- Answers file will only remember answers to questions specified in the questionary.

Expand All @@ -117,7 +117,7 @@ Summary:

[All changes here](https://github.com/copier-org/copier/milestone/12?closed=1). Summary:

- Make copier work fine with Git 2.28.
- Make Copier work fine with Git 2.28.
- We have [docs](https://copier.readthedocs.io/)!
- Polish docs a little bit.
- We now run tests on macOS and Windows!
Expand Down Expand Up @@ -156,7 +156,7 @@ Summary:

[All changes here](https://github.com/pykong/copier/milestone/7?closed=1). Summary:

- Assert minimum copier version.
- Assert minimum Copier version.
- Prettier prompts.
- Prompt self-templating.
- Better README.
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Feel free to discuss with our community through
We use some tools as part of our development workflow which you'll need to install into
your host environment:

- [poetry](https://python-poetry.org/) for packaging and dependency management
- [Poetry](https://python-poetry.org/) for packaging and dependency management
- [poethepoet](https://github.com/nat-n/poethepoet) for running development tasks
- [commitizen](https://commitizen-tools.github.io/commitizen/) for writing git commits
- [commitizen](https://commitizen-tools.github.io/commitizen/) for writing Git commits
easily

Or you can use
Expand All @@ -63,15 +63,15 @@ to start hacking with one click!

Ready to contribute? Here's how to set up the project for local development.

1. Fork the copier repo on GitHub.
1. Fork the Copier repo on GitHub.
2. Clone your fork locally:

```sh
git clone [email protected]:my-user/copier.git
cd copier
```

3. Use poetry to setup a development environment
3. Use Poetry to set up a development environment:

```sh
# Tell Poetry to create the virtualenv in the project directory
Expand All @@ -95,7 +95,7 @@ Ready to contribute? Here's how to set up the project for local development.

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass all tests
5. When you're done making changes, check that your changes pass all tests:
```sh
poe test
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@

A library and CLI app for rendering project templates.

- Works with **local** paths and **git URLs**.
- Your project can include any file and `Copier` can dynamically replace values in any
- Works with **local** paths and **Git URLs**.
- Your project can include any file and Copier can dynamically replace values in any
kind of text file.
- It generates a beautiful output and takes care of not overwrite existing files
unless instructed to do so.
Expand All @@ -33,7 +33,7 @@ To create a template:
```bash
📁 my_copier_template ------------------------ # your template project
├── 📄 copier.yml ---------------------------- # your template configuration
├── 📁 .git ---------------------------------- # your template is a git repository
├── 📁 .git ---------------------------------- # your template is a Git repository
├── 📁 {{project_name}} ---------------------- # a folder with a templated name
│ └── 📄 {{module_name}}.py.jinja ---------- # a file with a templated name
└── 📄 {{_copier_conf.answers_file}}.jinja --- # answers are recorded here
Expand Down Expand Up @@ -75,7 +75,7 @@ To generate a project from the template:
# Create a project from a local path
run_auto("path/to/project/template", "path/to/destination")
# Or from a git URL.
# Or from a Git URL.
run_auto("https://github.com/copier-org/copier.git", "path/to/destination")
# You can also use "gh:" as a shortcut of "https://github.com/"
Expand Down Expand Up @@ -108,7 +108,7 @@ Copier targets these main human audiences:
1. **Template consumers**. Programmers that want to start a new project quickly, or
that want to evolve it comfortably.

Non-humans should be happy also by using copier's CLI or API, as long as their
Non-humans should be happy also by using Copier's CLI or API, as long as their
expectations are the same as for those humans... and as long as they have feelings.
Templates have these goals:
Expand All @@ -124,7 +124,7 @@ can evolve into complex ones as needed.
## Browse or tag public templates
You can browse public copier templates in GitHub using
You can browse public Copier templates on GitHub using
[the `copier-template` topic](https://github.com/topics/copier-template). Use them as
inspiration!
Expand Down
2 changes: 1 addition & 1 deletion docs/comparisons.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ docs! We don't want to be biased, but it's easy that we tend to be:
a different suffix, or to use none.

[^4]:
Only for git templates, because Copier uses git tags to obtain available versions
Only for Git templates, because Copier uses Git tags to obtain available versions
and extract smart diffs between them.

[^5]: Context hooks are provided through the [`ContextHook` extension][context-hook].
Expand Down
18 changes: 9 additions & 9 deletions docs/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

It is important that you understand how Copier works. It has 2 kinds of configurations:

1. **Settings** for Copier itself. This includes things as minimal copier version
1. **Settings** for Copier itself. This includes things as minimal Copier version
required, which subdirectory to render, tasks to run, etc.
1. **Answers**. This is customized per template. The user answers template questions,
and those answers are stored as variables available for the template at rendering
Expand Down Expand Up @@ -352,7 +352,7 @@ templates.

!!! hint

You can use [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
You can use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
to sanely include shared code into templates.

!!! example
Expand Down Expand Up @@ -877,12 +877,12 @@ This allows you to keep separate the template metadata and the template code.

!!! question "Can I have multiple templates in a single repo using this option?"

The Copier recommendation is: **1 template = 1 git repository**.
The Copier recommendation is: **1 template = 1 Git repository**.

Why? Unlike almost all other templating engines, Copier supports
[smart project updates](updating.md). For that, Copier needs to know in which version it
was copied last time, and to which version you are evolving. Copier gets that
information from git tags. Git tags are shared across the whole git repository. Using a
information from Git tags. Git tags are shared across the whole Git repository. Using a
repository to host multiple templates would lead to many corner case situations that we
don't want to support.

Expand Down Expand Up @@ -914,7 +914,7 @@ This allows you to keep separate the template metadata and the template code.
!!! example

With this questions file and this directory structure, the user will be prompted which
python engine to use, and the project will be generated using the subdirectory whose
Python engine to use, and the project will be generated using the subdirectory whose
name matches the answer from the user:

```yaml title="copier.yaml"
Expand Down Expand Up @@ -963,7 +963,7 @@ _tasks:
- [invoke, "--search-root={{ _copier_conf.src_path }}", after-copy]
# You are able to output the full conf to JSON, to be parsed by your script
- [invoke, end-process, "--full-conf={{ _copier_conf|to_json }}"]
# Your script can be run by the same python environment used to run copier
# Your script can be run by the same Python environment used to run Copier
- ["{{ _copier_python }}", task.py]
```

Expand Down Expand Up @@ -1007,7 +1007,7 @@ templates suffix is _not_ empty, Copier will abort and print an error message.
- CLI flags: `g`, `--prereleases`
- Default value: `False`

Imagine that the template supports updates and contains these 2 git tags: `v1.0.0` and
Imagine that the template supports updates and contains these 2 Git tags: `v1.0.0` and
`v2.0.0a1`. Copier will copy by default `v1.0.0` unless you add `--prereleases`.

<!-- prettier-ignore-start -->
Expand All @@ -1030,7 +1030,7 @@ the `v2.0.0a1` tag unless this flag is enabled.
- CLI flags: `-r`, `-vcs-ref`
- Default value: N/A (use latest release)

When copying or updating from a git-versioned template, indicate which template version
When copying or updating from a Git-versioned template, indicate which template version
to copy.

This is stored automatically in the answers file, like this:
Expand All @@ -1043,7 +1043,7 @@ _commit: v1.0.0

Not supported in `copier.yml`.

By default, copier will copy from the last release found in template git tags, sorted as
By default, Copier will copy from the last release found in template Git tags, sorted as
[PEP 440][].

## Patterns syntax
Expand Down
6 changes: 3 additions & 3 deletions docs/creating.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating a template

A template is a directory: usually the root folder of a git repository.
A template is a directory: usually the root folder of a Git repository.

The content of the files inside the project template is copied to the destination
without changes, **unless they end with `.jinja`** (or
Expand All @@ -18,7 +18,7 @@ project, the user will be prompted to fill in or confirm the default values.
```bash
📁 my_copier_template ------------------------ # your template project
├── 📄 copier.yml ---------------------------- # your template configuration
├── 📁 .git ---------------------------------- # your template is a git repository
├── 📁 .git ---------------------------------- # your template is a Git repository
├── 📁 {{project_name}} ---------------------- # a folder with a templated name
│ └── 📄 {{module_name}}.py.jinja ---------- # a file with a templated name
└── 📄 {{_copier_conf.answers_file}}.jinja --- # answers are recorded here
Expand Down Expand Up @@ -89,7 +89,7 @@ Copier includes:
- It doesn't contain any data that is not easy to render to JSON or YAML.
- It contains special keys like `_commit` and `_src_path`, indicating how the last
template update was done.
- `_copier_conf` includes a representation of the current copier
- `_copier_conf` includes a representation of the current Copier
<!-- prettier-ignore -->
[Worker][copier.main.Worker] object, also slightly modified:
- It only contains JSON-serializable data.
Expand Down
6 changes: 3 additions & 3 deletions docs/generating.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ Use the `--data` command-line argument or the `data` parameter of the
`copier.run_auto()` function to pass whatever extra context you want to be available in
the templates. The arguments can be any valid Python value, even a function.

Use the `--vcs-ref` command-line argument to checkout a particular git ref before
Use the `--vcs-ref` command-line argument to checkout a particular Git ref before
generating the project.

[All the available options][copier.cli] are described with the `--help-all` option.

## Templates versions

By default, copier will copy from the last release found in template git tags, sorted as
By default, Copier will copy from the last release found in template Git tags, sorted as
[PEP 440](https://peps.python.org/pep-0440/), regardless of whether the template is from
a URL or a local clone of a git repository.
a URL or a local clone of a Git repository.

The exception to this is if you use a local clone of a template repository that has had
any modifications made, in this case Copier will use this modified working copy of the
Expand Down
12 changes: 6 additions & 6 deletions docs/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ true:

1. The template includes
[a valid `.copier-answers.yml` file](configuring.md#the-copier-answersyml-file).
2. The template is versioned with git (with tags).
3. The destination folder is versioned with git.
2. The template is versioned with Git (with tags).
3. The destination folder is versioned with Git.

If that's your case, then just enter the destination folder, make sure `git status`
shows it clean, and run:
Expand All @@ -15,18 +15,18 @@ shows it clean, and run:
copier update
```

This will read all available git tags, will compare them using
This will read all available Git tags, will compare them using
[PEP 440](https://www.python.org/dev/peps/pep-0440/), and will check out the latest one
before updating. To update to the latest commit, add `--vcs-ref=HEAD`. You can use any
other git ref you want.
other Git ref you want.

When updating, Copier will do its best to respect your project evolution by using the
answers you provided when copied last time. However, sometimes it's impossible for
Copier to know what to do with a diff code hunk. In those cases, you will find `*.rej`
files that contain the unresolved diffs. _You should review those manually_ before
committing.

You probably don't want `*.rej` files in your git history, but if you add them to
You probably don't want `*.rej` files in your Git history, but if you add them to
`.gitignore`, some important changes could pass unnoticed to you. That's why the
recommended way to deal with them is to _not_ add them to add a
[pre-commit](https://pre-commit.com/) (or equivalent) hook that forbids them, just like
Expand All @@ -38,7 +38,7 @@ repos:
hooks:
- id: forbidden-files
name: forbidden files
entry: found copier update rejection files; review them and remove them
entry: found Copier update rejection files; review them and remove them
language: fail
files: "\\.rej$"
```
Expand Down

0 comments on commit fc6bb03

Please sign in to comment.