📝 Attribute & document structlog_sentry source code

see: kiwicom/structlog-sentry#44
TeoZosa · Sep 12, 2021 · 69d66e3 · 69d66e3
1 parent 6248ade
commit 69d66e3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/structlog_sentry_logger/structlog_sentry.py b/structlog_sentry_logger/structlog_sentry.py
@@ -1,3 +1,13 @@
+"""Fork of `structlog-sentry`_ which adds full type information
+
+- Necessary for proper Mypyc C extension compilation.
+- Will directly depend on `structlog-sentry`_ once associated PR is merged upstream
+(see: `kiwicom/structlog-sentry#44`_).
+
+.. _`structlog-sentry`: https://github.com/kiwicom/structlog-sentry
+.. _`kiwicom/structlog-sentry#44`: https://github.com/kiwicom/structlog-sentry/pull/44
+
+"""
 # pylint: disable=unsubscriptable-object
 import logging
 import sys