docs: optimize format usage

Undertone0809 · Sep 3, 2024 · 1d35e47 · 1d35e47
1 parent 53ed43e
commit 1d35e47
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ make pre-commit-install
 After installation you may execute code formatting. We use [ruff](https://github.com/astral-sh/ruff) to format our code.
 
 ```bash
-make formatting
+make format
 ```
 
 ### Checks
@@ -42,7 +42,7 @@ Before submitting your code please do the following steps:
 1. Add any changes you want
 1. Add tests for the new changes
 1. Edit documentation if you have changed something significant
-1. Run `make formatting` to format your changes.
+1. Run `make format` to format your changes.
 1. Run `make lint` to ensure that types, security and docstrings are okay.
 
 ## Other help

diff --git a/Makefile b/Makefile
@@ -27,7 +27,6 @@ polish-codestyle:
 	poetry run ruff format --config pyproject.toml hooks tests p3g
 	poetry run ruff check --fix --config pyproject.toml hooks tests p3g
 
-formatting: polish-codestyle
 format: polish-codestyle
 
 test:

diff --git a/README.md b/README.md
@@ -191,7 +191,7 @@ Automatic formatting uses `ruff`.
 make polish-codestyle
 
 # or use synonym
-make formatting
+make format
 ```
 
 Codestyle checks only, without rewriting files:

diff --git a/README_zh.md b/README_zh.md
@@ -182,7 +182,7 @@ make pre-commit-install
 make polish-codestyle
 
 # 或使用同义词
-make formatting
+make format
 ```
 
 仅检查代码风格，不重写文件：

diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -1,4 +1,5 @@
 """This module is called after project is created."""
+
 import textwrap
 from pathlib import Path
 from shutil import move, rmtree
@@ -89,7 +90,7 @@ def print_further_instructions(project_name: str, github: str) -> None:
 
     4) Run codestyle:
 
-        $ make formatting
+        $ make format
 
     5) Upload initial code to GitHub:
 

diff --git a/...ter.project_name.lower().replace(' ', '_').replace('-', '_') }}/CONTRIBUTING.md b/...ter.project_name.lower().replace(' ', '_').replace('-', '_') }}/CONTRIBUTING.md
@@ -26,7 +26,7 @@ make pre-commit-install
 After installation you may execute code formatting. We use [ruff](https://github.com/astral-sh/ruff) to format our code.
 
 ```bash
-make formatting
+make format
 ```
 
 ### Checks
@@ -42,7 +42,7 @@ Before submitting your code please do the following steps:
 1. Add any changes you want
 1. Add tests for the new changes
 1. Edit documentation if you have changed something significant
-1. Run `make formatting` to format your changes.
+1. Run `make format` to format your changes.
 1. Run `make lint` to ensure that types, security and docstrings are okay.
 
 ## Other help

diff --git a/...kiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/README.md b/...kiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/README.md
@@ -84,7 +84,7 @@ Automatic formatting uses `ruff`.
 make polish-codestyle
 
 # or use synonym
-make formatting
+make format
 ```
 
 Codestyle checks only, without rewriting files: