diff --git a/README.md b/README.md index 77bf9e1..292f756 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ This repository is a template for a python 🐍 project using the poetry contain - [Pytest](https://docs.pytest.org/en/7.2.x/): This serves as the codebase test runner. - [Requests](https://requests.readthedocs.io/en/latest/): This is the project's means of communicating with external APIs. - [Responses](https://github.com/getsentry/responses): This is used in conjunction with Pytest and Requests to mock API calls in the test module. +- [Numpy Pydoc Styling](https://numpy.org/doc/1.20/docs/howto_document.html): Ruff works to require strict Numpy-style pydoc strings. ### Project Requirements - Python version: `^3.11` diff --git a/project/__main__.py b/project/__main__.py index 79d228f..751f245 100644 --- a/project/__main__.py +++ b/project/__main__.py @@ -1,4 +1,4 @@ -"""This file serves as the entry point for the project module.""" +"""Serves as the entry point for the project module.""" if __name__ == "__main__": print("oh, what up?") diff --git a/pyproject.toml b/pyproject.toml index 2f174ae..36ca420 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,7 +29,7 @@ target-version = "py311" select = ["D"] [tool.ruff.pydocstyle] -convention = "google" +convention = "numpy" [tool.ruff.extend-per-file-ignores] "__init__.py" = ["D104"] diff --git a/test/test_example.py b/test/test_example.py index 419f238..e9b3e03 100644 --- a/test/test_example.py +++ b/test/test_example.py @@ -1,4 +1,4 @@ -"""This file serves as an example of a basic test.""" +"""Serves as an example of a basic test.""" def test_example():