Skip to content

Commit

Permalink
fix toml syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep committed Nov 21, 2023
1 parent 936d00d commit e7ba571
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions {{cookiecutter.project_name}}/docs/template_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ You'll notice that the command `git commit` installed a bunch of packages and tr
There is a chance that `git commit -m "first commit"` fails due to the `prettier` pre-commit formatting the file `.cruft.json`. No problem, you have just experienced what pre-commit checks do in action. Just go ahead and re-add the modified file and try to commit again:

```bash
git add -u # update all tracked file
git commit -m "first commit"
git add -u # update all tracked file
git commit -m "first commit"
```

:::
Expand Down Expand Up @@ -247,14 +247,14 @@ Rule categories are selectively enabled by including them under the `select` key

```toml
[tool.ruff]
...
# ...
select = [
"F", # Errors detected by Pyflakes
"E", # Error detected by Pycodestyle
"W", # Warning detected by Pycodestyle
"I", # isort
...
# ...
]
```
Expand All @@ -264,10 +264,10 @@ You can find a long list of checks that this template disables by default sittin
```toml
ignore = [
...
# ...
# __magic__ methods are are often self-explanatory, allow missing docstrings
"D105",
...
# ...
]
```
Expand Down

0 comments on commit e7ba571

Please sign in to comment.