fix: docstrings

Author: MicaelJarniac

.pre-commit-config.yaml

@@ -11,11 +11,12 @@ repos:
     rev: 6.1.1
     hooks:
     -   id: pydocstyle
+        files: ^buildurl
 -   repo: https://gitlab.com/pycqa/flake8
     rev: 3.9.2
     hooks:
     -   id: flake8
-        additional_dependencies: [flake8-black, flake8-isort, flake8-docstrings]
+        # additional_dependencies: [flake8-black, flake8-isort, flake8-docstrings]
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.910
     hooks:

buildurl/__init__.py

@@ -1,4 +1,4 @@
-"""Simple URL builder"""
+"""Simple URL builder."""
 
 __version__ = "4.0.0"
 

buildurl/builder.py

@@ -1,3 +1,5 @@
+"""BuildURL's core."""
+
 from copy import deepcopy
 from typing import Any, Dict, List, Optional, Tuple, Union
 from urllib.parse import parse_qs, urlencode, urlsplit, urlunsplit
@@ -31,6 +33,7 @@ class BuildURL:
     """
 
     def __init__(self, base: str = "", force_trailing_slash: bool = False):
+        """Initialize a new instance of BuildURL."""
         purl = urlsplit(base)
 
         # scheme://netloc/path;params?query#fragment
@@ -68,7 +71,7 @@ def copy(self) -> "BuildURL":
         return deepcopy(self)
 
     def set_force_trailing_slash(self, enabled: bool = True) -> "BuildURL":
-        """Sets the `force_trailing_slash` attribute
+        """Set the `force_trailing_slash` attribute.
 
         Args:
             enabled:
@@ -115,7 +118,6 @@ def add_path(self, *args: Path) -> "BuildURL":
             >>> print(url.get)
             https://example.com/never/stopping/to/play/with/paths
         """
-
         path_list = list()
         for path in args:
             if isinstance(path, str):
@@ -166,7 +168,6 @@ def add_query(self, *args: Query, **kwargs) -> "BuildURL":
             >>> print(url.get)
             https://example.com?key=value&another=query&more=stuff&a=b&c=d&e=f
         """
-
         query_dict = dict()
         for query in args:
             if isinstance(query, str):
@@ -250,7 +251,6 @@ def __itruediv__(self, path: Path) -> "BuildURL":
             >>> print(url.get)
             https://example.com/test/more/paths/again/and/again/
         """
-
         self.add_path(path)
         return self
 
@@ -274,7 +274,6 @@ def __truediv__(self, path: Path) -> "BuildURL":
             >>> print(new_url.get)
             https://example.com/testing
         """
-
         out = self.copy()
         out /= path
         return out
@@ -300,7 +299,6 @@ def __iadd__(self, query: Query) -> "BuildURL":
             >>> print(url.get)
             https://example.com?key=value&another=query&more=stuff
         """
-
         self.add_query(query)
         return self
 
@@ -324,7 +322,6 @@ def __add__(self, query: Query) -> "BuildURL":
             >>> print(new_url.get)
             https://example.com?test=it
         """
-
         out = self.copy()
         out += query
         return out
@@ -340,7 +337,6 @@ def __repr__(self) -> str:
             >>> print(repr(url))
             BuildURL(base='https://example.com/test?now=true', force_trailing_slash=False)
         """
-
         return f"{self.__class__.__name__}(base='{self.get}', force_trailing_slash={self.force_trailing_slash})"
 
     def __str__(self) -> str:
@@ -359,7 +355,6 @@ def __str__(self) -> str:
             >>> print(url)
             https://example.com/test
         """
-
         return self.get
 
     def __len__(self) -> int:

docs/conf.py

@@ -1,8 +1,9 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""Configuration file for the Sphinx documentation builder.
+
+This file only contains a selection of the most common options. For a full
+list see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 
 # -- Path setup --------------------------------------------------------------
 

setup.cfg

@@ -35,6 +35,7 @@ profile = black
 
 [pydocstyle]
 convention = google
+match_dir = buildurl
 
 [semantic_release]
 changelog_capitalize = false

setup.py

@@ -1,3 +1,5 @@
+"""Project setup."""
+
 import setuptools
 
 setuptools.setup()