docs: add pycodestyle checks

Author: cjumel

pyproject.toml

@@ -55,10 +55,14 @@ line-length = 100
 target-version = "py39"
 
 [tool.ruff.lint]
-select = ["E", "F", "I", "S", "UP"]
+extend-ignore = ["D107"]
+pydocstyle = { convention = "google" }
+select = ["D", "E", "F", "I", "S", "UP"]
 
 [tool.ruff.lint.extend-per-file-ignores]
-"tests/**/*_test.py" = ["S101"]
+"examples/*.py" = ["D"]
+"src/linkup/__init__.py" = ["D104"]
+"tests/**/*test.py" = ["D", "S101"]
 
 [build-system]
 build-backend = "hatchling.build"

src/linkup/client.py

@@ -1,3 +1,5 @@
+"""Linkup client, the entrypoint for Linkup functions."""
+
 import json
 import os
 from datetime import date

src/linkup/errors.py

@@ -1,3 +1,6 @@
+"""Linkup custom errors."""
+
+
 class LinkupInvalidRequestError(Exception):
     """Invalid request error, raised when the Linkup API returns a 400 status code.
 

src/linkup/types.py

@@ -1,3 +1,5 @@
+"""Input and output types for Linkup functions."""
+
 from typing import Any, Literal, Optional, Union
 
 from pydantic import BaseModel, ConfigDict, Field