Documentation

favro_sync/favro_client.py

@@ -1,3 +1,7 @@
+"""Favro API Client.
+
+Implements methods for interacting with the  [Favro API](https://favro.com/developer/).
+"""
 import dataclasses
 from collections.abc import Iterator
 from logging import getLogger
@@ -54,6 +58,11 @@ class CardCache:
 
 
 class FavroClient:
+    """Favro API Client.
+
+    Implements methods for interacting with the  [Favro API](https://favro.com/developer/).
+    """
+
     def __init__(
         self,
         *,

favro_sync/favro_data_model.py

@@ -1,3 +1,8 @@
+"""Favro Data Model.
+
+Based on the descriptions on the [Favro API Specification
+Page](https://favro.com/developer/), and observed behaviour.
+"""
 import dataclasses
 import datetime
 from typing import Any