Update docstrings

Author: rlan

README.md

@@ -49,14 +49,16 @@ schwab2pp --help
 ```txt
  Usage: schwab2pp [OPTIONS] [SCHWAB_CSV] [PP_CSV]
 
- Converts a transactions CSV file from Charles Schwab to an
- equivalent and ready-to-import CSV file for Portfolio
+ Convert transactions from Charles Schwab for Portfolio
  Performance.
 
+ Convert a transactions CSV file from Charles Schwab to an
+ equivalent and ready-to-import CSV file for Portfolio
+ Performance.
 
 ╭─ Arguments ─────────────────────────────────────────────────╮
-│   schwab_csv      [SCHWAB_CSV]  Input Charles Schwab CSV    │
-│                                 file                        │
+│   schwab_csv      [SCHWAB_CSV]  CSV file from Charles       │
+│                                 Schwab                      │
 │                                 [default: None]             │
 │   pp_csv          [PP_CSV]      Resulting CSV file for      │
 │                                 Portfolio Performance       │
@@ -69,8 +71,7 @@ schwab2pp --help
 │                               current shell, to copy it or  │
 │                               customize the installation.   │
 │ --help                        Show this message and exit.   │
-╰─────────────────────────────────────────────────────────────╯
-```
+╰─────────────────────────────────────────────────────────────╯```
 
 Example:
 

pyproject.toml

@@ -58,6 +58,7 @@ line-length = 88
 select = [
     # See: https://docs.astral.sh/ruff/rules/
     # Basic list from: https://docs.astral.sh/ruff/linter/#rule-selection
+    "D", # https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
     "E", # https://docs.astral.sh/ruff/rules/#error-e
     "F", # https://docs.astral.sh/ruff/rules/#pyflakes-f
     "UP", # https://docs.astral.sh/ruff/rules/#pyupgrade-up
@@ -92,5 +93,8 @@ ignore = [
     "ISC002", # https://docs.astral.sh/ruff/rules/multi-line-implicit-string-concatenation/
 ]
 
+[tool.ruff.lint.pydocstyle]
+convention = "numpy" # https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
+
 [tool.ruff.format]
-docstring-code-format = true
+docstring-code-format = true # https://docs.astral.sh/ruff/formatter/#docstring-formatting

src/schwab2pp/__init__.py

@@ -1,3 +1,8 @@
+"""schwab2pp package.
+
+This package contains a CLI app.
+"""
+
 from importlib.metadata import version
 
 __version__ = version("schwab2pp")

src/schwab2pp/cli.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3
+"""CLI wrapper for the conversion.
+
+This module creates a CLI app and validates arguments.
+"""
 
 from pathlib import Path
 from typing import Optional
@@ -14,18 +18,18 @@
 @app.command()
 def main(
     schwab_csv: Annotated[
-        Optional[Path], typer.Argument(help="Input Charles Schwab CSV file")
+        Optional[Path], typer.Argument(help="CSV file from Charles Schwab")
     ] = None,
     pp_csv: Annotated[
         Path,
         typer.Argument(help="Resulting CSV file for Portfolio Performance"),
     ] = Path("pp.csv"),
 ) -> int:
-    """
-    Converts a transactions CSV file from Charles Schwab to an equivalent and
+    """Convert transactions from Charles Schwab for Portfolio Performance.
+
+    Convert a transactions CSV file from Charles Schwab to an equivalent and
     ready-to-import CSV file for Portfolio Performance.
     """
-
     # Argument validation
     if schwab_csv is None:
         print("Missing input Schwab CSV file")

src/schwab2pp/convert.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3
+"""Conversion of transactions.
+
+This module converts Schwab transactions to Portfolio Performance ones.
+"""
 
 import sys
 from pathlib import Path
@@ -7,7 +11,7 @@
 
 
 def remove_currency(text: str) -> str:
-    """Removes currency symbol from string. Works for negative values."""
+    """Remove currency symbol from string. Work for negative values."""
     import locale
     import re
 
@@ -17,12 +21,11 @@ def remove_currency(text: str) -> str:
 
 
 def convert(schwab_csv: Path, pp_csv: Path) -> int:
-    """Converts transactions from Charles Schwab to Portfolio Performance.
+    """Convert transactions from Charles Schwab for Portfolio Performance.
 
-    Converts a transactions CSV file from Charles Schwab to an equivalent and
+    Convert a transactions CSV file from Charles Schwab to an equivalent and
     ready-to-import CSV file for Portfolio Performance.
     """
-
     # A Charles Scwab CSV starts with a prefix and a suffix row
     # Prefix: "Transactions  for account..."
     # Suffix: "Transactions Total"