From e99dee7a86807f28791ee1a0227638e71b61c373 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Sun, 3 Dec 2023 22:19:40 +0100 Subject: [PATCH] Documentation --- socials_util/__init__.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/socials_util/__init__.py b/socials_util/__init__.py index 3e60eef..beb1c34 100644 --- a/socials_util/__init__.py +++ b/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