Merge pull request #105 from elliot-100/docstring-improvements

Docstring improvements

CHANGELOG.md

@@ -13,6 +13,7 @@ Historic and pre-release versions aren't necessarily included.
 ### Changed
 
 - Rename `profile` module as it shadowed a Python built-in
+- Docs: docstring improvements
 - Update dev dependency: ruff, and its config
 
 ### Removed

britishcycling_clubs/manager.py

@@ -35,16 +35,16 @@ def get_manager_member_counts(
 
     Parameters
     ----------
-    club_id :
+    club_id
         From the URL used to access club pages.
 
-    username :
+    username
         Username
 
-    password :
+    password
         Password
 
-    manager_page_load_delay :
+    manager_page_load_delay
         Time (s) allowed for club manager page to load. Defaults to 5.
         Consider increasing if 'Active member count was zero' exceptions occur.
 
@@ -54,8 +54,8 @@ def get_manager_member_counts(
 
     Raises
     ------
-    ValueError :
-        if zero 'active members' would be returned, as it's assumed this indicates
+    ValueError
+        if zero 'active' members would be returned, as it's assumed this indicates
         an issue with data collection.
     """
     logger = logging.getLogger(__name__)
@@ -101,12 +101,12 @@ def manager_url_via_login(club_id: str) -> str:
 
     Parameters
     ----------
-    club_id :
+    club_id
         From the URL used to access club pages.
 
     Returns
     -------
-    str :
+    str
         URL
 
     """

britishcycling_clubs/profile_.py

@@ -21,7 +21,7 @@ def get_profile_info(club_id: str) -> ProfileInfo:
 
     Parameters
     ----------
-    club_id :
+    club_id
         From the URL used to access club pages.
 
     Returns
@@ -30,7 +30,7 @@ def get_profile_info(club_id: str) -> ProfileInfo:
 
     Raises
     ------
-    ValueError :
+    ValueError
         if information can't be located.
     """
     url = profile_url(club_id)
@@ -51,12 +51,12 @@ def profile_url(club_id: str) -> str:
 
     Parameters
     ----------
-    club_id :
+    club_id
         From the URL used to access club pages.
 
     Returns
     -------
-    str :
+    str
         URL
     """
     return f"{_PROFILE_BASE_URL}{club_id}/"