Documentation

socials_util/__init__.py

@@ -1,3 +1,7 @@
+'''
+Small utility for detecting social websites.
+'''
+
 from dataclasses import dataclass
 from enforce_typing import enforce_types
 from typing import List, Set, Optional, Union
@@ -7,6 +11,9 @@ import re
 import urllib.parse
 
 class SocialSiteId(enum.Enum):
+    '''
+    The great social website enum.
+    '''
     REDDIT = 1 # Should have been named REDDIT_SUBREDDIT
     REDDIT_USER = 22
     REDDIT_SUBREDDIT = REDDIT