add module docstring

MarshalX · Dec 14, 2024 · b27b890 · b27b890
1 parent a92a97e
commit b27b890
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/atproto_client/models/string_formats.py b/packages/atproto_client/models/string_formats.py
@@ -1,3 +1,14 @@
+"""AT Proto string format validation.
+
+*Note*: These formats are a working empirical understanding of the following resources:
+
+- https://atproto.com/specs/lexicon
+
+- https://github.com/bluesky-social/atproto/tree/main/interop-test-files/syntax
+
+see [this pr](https://github.com/MarshalX/atproto/pull/406) for more details.
+"""
+
 import re
 from datetime import datetime
 from typing import Callable, Mapping, Set, Union, cast