From ad109481ff06ea4ae26acd3e1279fc056fd5ee54 Mon Sep 17 00:00:00 2001 From: aandres Date: Wed, 21 Jun 2023 12:32:56 +0100 Subject: [PATCH] Add hook for pydoc --- .pre-commit-config.yaml | 7 +++++++ beavers/__init__.py | 1 + beavers/engine.py | 1 + pyproject.toml | 3 +++ 4 files changed, 12 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index adac2df..95cc954 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -29,3 +29,10 @@ repos: additional_dependencies: - toml args: [--config=pyproject.toml] + - repo: https://github.com/pycqa/pydocstyle + rev: 6.3.0 + hooks: + - id: pydocstyle + files: ^beavers/replay.py + additional_dependencies: + - tomli diff --git a/beavers/__init__.py b/beavers/__init__.py index e69de29..8e40865 100644 --- a/beavers/__init__.py +++ b/beavers/__init__.py @@ -0,0 +1 @@ +"""beavers package module""" diff --git a/beavers/engine.py b/beavers/engine.py index 5f1045f..0b35a5d 100644 --- a/beavers/engine.py +++ b/beavers/engine.py @@ -1,3 +1,4 @@ +"""Module for building and representing dags and nodes""" from __future__ import annotations import collections.abc diff --git a/pyproject.toml b/pyproject.toml index 00f4637..0edc244 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,3 +66,6 @@ folders = [ {path = "beavers"}] [tool.ruff] line-length = 88 + +[tool.pydocstyle] +ignore = ["D102", "D107", "D203", "D212"]