docs: add docstrings to public API methods

Author: linuxdaemon

.devcontainer/devcontainer.json

@@ -38,7 +38,8 @@
                 "ms-python.black-formatter",
                 "ms-python.isort",
                 "ms-azuretools.vscode-docker",
-                "ms-python.mypy-type-checker"
+                "ms-python.mypy-type-checker",
+                "sunipkm.autodocstringpy"
             ],
             "settings": {
                 "python.defaultInterpreterPath": "~/.virtualenvs/py-irclib/bin/python",

.vscode/extensions.json

@@ -10,6 +10,7 @@
         "ms-python.black-formatter",
         "ms-python.isort",
         "ms-azuretools.vscode-docker",
-        "ms-python.mypy-type-checker"
+        "ms-python.mypy-type-checker",
+        "sunipkm.autodocstringpy"
     ]
 }

.vscode/settings.json

@@ -11,5 +11,7 @@
         "editor.wordBasedSuggestions": "off",
         "editor.defaultFormatter": "ms-python.black-formatter"
     },
-    "python.analysis.diagnosticMode": "workspace"
+    "python.analysis.diagnosticMode": "workspace",
+    "autoDocstringPy.docstringFormat": "google-notypes",
+    "autoDocstringPy.startOnNewLine": true
 }

irclib/__init__.py

@@ -1,4 +1,4 @@
-"""IRC parser and utility library"""
+"""IRC parser and utility library."""
 
 from irclib._version import (
     __version__,

irclib/errors.py

@@ -1,7 +1,7 @@
-"""Library exceptions"""
+"""Library exceptions."""
 
 __all__ = ("ParseError",)
 
 
 class ParseError(ValueError):
-    """An exception representing some error during parsing"""
+    """An exception representing some error during parsing."""