docs: add docstring API documentation (#327)

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

Author: threeal

pyproject.toml

@@ -46,7 +46,7 @@ include = ["src"]
 
 [tool.ruff.lint]
 select = ["ALL"]
-ignore = ["COM812", "D"]
+ignore = ["COM812", "D203", "D213"]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["S101"]
+"tests/*" = ["S101", "D"]

src/bonacci/__init__.py

@@ -1,3 +1,5 @@
+"""Example Python package for generating Fibonacci sequences."""
+
 from .sequence import fibonacci_sequence
 
 __all__ = ["fibonacci_sequence"]

src/bonacci/__main__.py

@@ -1,10 +1,13 @@
+"""Example main module for the CLI application."""
+
 import argparse
 import sys
 
 from . import fibonacci_sequence
 
 
 def main() -> None:
+    """Generate and print a Fibonacci sequence based on command line arguments."""
     parser = argparse.ArgumentParser(
         prog="bonacci",
         description="Generate a Fibonacci sequence up to the given number of terms",

src/bonacci/sequence.py

@@ -1,3 +1,6 @@
+"""Example functions for generating Fibonacci sequences."""
+
+
 def fibonacci_sequence(n: int) -> list[int]:
     """Generate a Fibonacci sequence up to the given number of terms."""
     if n <= 0: