From 869972a9bbfcad8b2b27dda7896bc50f108de31d Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Mon, 7 Jul 2025 10:11:29 +0700 Subject: [PATCH] docs: add docstring API documentation Signed-off-by: Alfi Maulana --- pyproject.toml | 4 ++-- src/bonacci/__init__.py | 2 ++ src/bonacci/__main__.py | 3 +++ src/bonacci/sequence.py | 3 +++ 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 630a0a3..b5522b8 100644 --- a/pyproject.toml +++ b/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"] diff --git a/src/bonacci/__init__.py b/src/bonacci/__init__.py index a986c71..a2866f8 100644 --- a/src/bonacci/__init__.py +++ b/src/bonacci/__init__.py @@ -1,3 +1,5 @@ +"""Example Python package for generating Fibonacci sequences.""" + from .sequence import fibonacci_sequence __all__ = ["fibonacci_sequence"] diff --git a/src/bonacci/__main__.py b/src/bonacci/__main__.py index c075fb3..14471f3 100644 --- a/src/bonacci/__main__.py +++ b/src/bonacci/__main__.py @@ -1,3 +1,5 @@ +"""Example main module for the CLI application.""" + import argparse import sys @@ -5,6 +7,7 @@ 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", diff --git a/src/bonacci/sequence.py b/src/bonacci/sequence.py index a5deb5c..f520888 100644 --- a/src/bonacci/sequence.py +++ b/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: