Skip to content

Commit 0850778

Browse files
committed
chore: add docstrings to the templates noxfile.py
1 parent 146fb5a commit 0850778

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

noxfile.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151

5252
@nox.session(name="generate-demo-project", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
5353
def generate_demo_project(session: Session) -> None:
54+
"""Generates a project demo using the cookiecutter-robust-python template."""
5455
session.install("cookiecutter", "platformdirs", "loguru", "typer")
5556
session.run(
5657
"python",
@@ -61,6 +62,7 @@ def generate_demo_project(session: Session) -> None:
6162

6263
@nox.session(name="sync-uv-with-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
6364
def sync_uv_with_demo(session: Session) -> None:
65+
"""Syncs the uv environment with the current demo project."""
6466
session.install("cookiecutter", "platformdirs", "loguru", "typer")
6567
session.run(
6668
"python",
@@ -71,6 +73,7 @@ def sync_uv_with_demo(session: Session) -> None:
7173

7274
@nox.session(name="uv-in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
7375
def uv_in_demo(session: Session) -> None:
76+
"""Runs a uv command in a new project demo project then syncs with it."""
7477
session.install("cookiecutter", "platformdirs", "loguru", "typer")
7578
session.run(
7679
"python",
@@ -90,6 +93,7 @@ def uv_in_demo(session: Session) -> None:
9093

9194
@nox.session(name="in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
9295
def in_demo(session: Session) -> None:
96+
"""Generates a project demo and run a uv command in it."""
9397
session.install("cookiecutter", "platformdirs", "loguru", "typer")
9498
session.run(
9599
"python",

0 commit comments

Comments
 (0)