improve documentation

Author: elfkuzco

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Remove `black` from `pyproject.toml` and `tasks.py`
 - Upgrade `ruff` to `0.15.12`
 - Merge `check` and `lint` features into `qa`
+- Remove `lint-black`, `lint-ruff`, `fix-black`, `fix-ruff`, `lintall`, `fixall`, and
+  `check-pyright` invoke tasks
+- Add new invoke tasks: `check-lint`, `check-format`, `check-type`, `check-all`,
+  `fix-format`, `fix-lint` and `fix-all`
 
 ### Changed
 

docs/Usage.md

@@ -19,8 +19,6 @@ If you've not already read it, please check our [Policy](./Policy.md) first.
 ❯ hatch run test:run
 # run tests in a single matrixed' env
 ❯ hatch env run -e test -i py=3.11 coverage
-# run static type checks
-❯ hatch env run -e qa check-type
 
 # building packages
 ❯ hatch build
@@ -38,12 +36,13 @@ If you've not already read it, please check our [Policy](./Policy.md) first.
 # scripts discovery
 ❯ inv -l
 
-# linting, testing, coverage, static type checks
+# check linting, formatting and static type checks
 ❯ inv check-all
+# fix everything automatically
 ❯ inv fix-all
+# run tests
 ❯ inv test
 ❯ inv coverage
-❯ inv check-type
 
 # building packages
 ❯ pip install build

tasks.py

@@ -50,12 +50,14 @@ def _lint(ctx: Context, args: str = "."):
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
 def check_lint(ctx: Context, args: str = "."):
+    """check linting with ruff"""
     args = args or "."  # needed for hatch script
     _lint(ctx, args)
 
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
 def fix_lint(ctx: Context, args: str = "."):
+    """fix linting issues with ruff"""
     args = args or "."  # needed for hatch script
     _lint(ctx, f"--fix {args}")
 
@@ -75,19 +77,21 @@ def _format(ctx: Context, args: str = "."):
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
 def check_format(ctx: Context, args: str = "."):
+    """check formatting with ruff"""
     args = args or "."  # needed for hatch script
     _format(ctx, f"--check {args}")
 
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
 def fix_format(ctx: Context, args: str = "."):
+    """fix formatting with ruff"""
     args = args or "."  # needed for hatch script
     _format(ctx, args)
 
 
 @task(optional=["args"], help={"args": "additional arguments"})
 def check_all(ctx: Context, args: str = ""):
-    """check static types"""
+    """check linting, formatting and static types"""
     args = args or "."  # needed for hatch script
     check_lint(ctx, args)
     check_format(ctx, args)