docs: usage-focused command help texts (#18)

Add help text for command groups
-----------------------------------

* dependencies
* voldemort
* expensive-loop

Improve help text for `create` commands
-----------------------------------------

Create rule with <x> template
=>
Create rule to <achieve a goal>

how => what

Fix README
--------------

fix: order of paragraphs in the README

version 0.6.1

Author: reka

CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.1] - 2023-03-05
+
+### Added
+
+* Help for command groups. 
+
+### Updated
+
+* Help for `create` commands: more usage-focused
+
+### Fixed
+
+* README: order of paragraphs
+
 ## [0.6.0] - 2023-02-16
 
 ### Added

README.md

@@ -142,17 +142,6 @@ Loops often cause performance problems. Especially, if they execute expensive op
 sourcery-rules expensive-loop create
 ```
 
-## Using the Generated Rules
-
-The generated rules can be used by Sourcery to review your project.
-If you copy the generated rules into your project's `.sourcery.yaml`, Sourcery will use them automatically.
-
-All the generated rules have the tag `architecture`. Once you've copied them to your `.sourcery.yaml`, you can run them with:
-
-```
-sourcery review --enable architecture .
-```
-
 You'll be prompted to provide:
 
 * the fully qualified name of the function that shouldn't be called in loops
@@ -163,3 +152,14 @@ You'll be prompted to provide:
 
 * for `for` loops
 * for `while` loops
+
+## Using the Generated Rules
+
+The generated rules can be used by Sourcery to review your project.
+If you copy the generated rules into your project's `.sourcery.yaml`, Sourcery will use them automatically.
+
+All the generated rules have the tag `architecture`. Once you've copied them to your `.sourcery.yaml`, you can run them with:
+
+```
+sourcery review --enable architecture .
+```

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sourcery-rules-generator"
-version = "0.6.0"
+version = "0.6.1"
 description = "Generate architecture rules for Python projects."
 license = "MIT"
 authors = ["reka <[email protected]>"]

sourcery_rules_generator/__init__.py

@@ -1 +1 @@
-__version__ = "0.6.0"
+__version__ = "0.6.1"

sourcery_rules_generator/cli/cli.py

@@ -12,9 +12,15 @@
 from sourcery_rules_generator import __version__
 
 app = typer.Typer(rich_markup_mode="markdown")
-app.add_typer(dependencies_cli.app, name="dependencies")
-app.add_typer(voldemort_cli.app, name="voldemort")
-app.add_typer(expensive_loop_cli.app, name="expensive-loop")
+app.add_typer(
+    dependencies_cli.app, name="dependencies", help="Detect not allowed imports."
+)
+app.add_typer(voldemort_cli.app, name="voldemort", help="Detect deny-listed words.")
+app.add_typer(
+    expensive_loop_cli.app,
+    name="expensive-loop",
+    help="Detect expensive calls in loops.",
+)
 
 
 @app.callback(invoke_without_command=True)

sourcery_rules_generator/cli/dependencies_cli.py

@@ -56,7 +56,10 @@ def create(
         help='Display less info about the "Dependencies" template.',
     ),
 ):
-    """Create a new Sourcery dependency rule."""
+    """Create rules to check the dependencies between packages of a project.
+
+    Create rules to verify that internal and external packages are imported only by the allowed parts of a project.
+    """
     interactive = sys.stdin.isatty() and interactive_flag
     stderr_console = Console(stderr=True)
     if interactive and not quiet:

sourcery_rules_generator/cli/expensive_loop_cli.py

@@ -50,7 +50,7 @@ def create(
         help='Display less info about the "Expensive Loop" template.',
     ),
 ):
-    """Create a new Sourcery Expensive Loop rule."""
+    """Create a rule to detect an expensive call in a loop."""
     interactive = sys.stdin.isatty() and interactive_flag
     stderr_console = Console(stderr=True)
     if interactive and not quiet:

sourcery_rules_generator/cli/voldemort_cli.py

@@ -50,7 +50,7 @@ def create(
         help='Display less info about the "Voldemort" template.',
     ),
 ):
-    """Create a new Sourcery Voldemort rule."""
+    """Create a rule to flag a deny-listed word."""
     interactive = sys.stdin.isatty() and interactive_flag
     stderr_console = Console(stderr=True)
     if interactive and not quiet:

tests/test_version.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "0.6.0"
+    assert __version__ == "0.6.1"