Skip to content

Commit 30183ef

Browse files
committed
chore: improve docstrings for the generated project's scripts
1 parent 70a7bff commit 30183ef

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

{{cookiecutter.project_name}}/scripts/setup-git.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
"""Script responsible for coordinating first time project setup."""
1+
"""Script responsible for first time setup of the project's git repo.
2+
3+
Since this a first time setup script, we intentionally only use builtin Python dependencies.
4+
"""
25
import argparse
36
import subprocess
47
from pathlib import Path
@@ -15,7 +18,7 @@ def main() -> None:
1518

1619

1720
def setup_git(path: Path, github_user: str, repo_name: str) -> None:
18-
"""Set up the provided cookiecutter-robust-python project for the first time."""
21+
"""Set up the provided cookiecutter-robust-python project's git repo."""
1922
commands: list[list[str]] = [
2023
["git", "init"],
2124
["git", "branch", "-M", "main"],

{{cookiecutter.project_name}}/scripts/setup-venv.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
"""Script responsible for coordinating first time project setup."""
1+
"""Script responsible for first time setup of the project's venv.
2+
3+
Since this a first time setup script, we intentionally only use builtin Python dependencies.
4+
"""
25
import argparse
36
import subprocess
47
from pathlib import Path

0 commit comments

Comments
 (0)