From d9be9430db8c0f1c7bda89aada5826afcb48f56a Mon Sep 17 00:00:00 2001
From: Ferdinand Thiessen <rpm@fthiessen.de>
Date: Sun, 19 Dec 2021 19:01:27 +0100
Subject: [PATCH] docs(misc): Some more documentation fixes

---
 flaschengeist/__init__.py                  | 8 +++-----
 flaschengeist/controller/__init__.py       | 1 +
 flaschengeist/controller/userController.py | 2 +-
 flaschengeist/utils/__init__.py            | 1 +
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/flaschengeist/__init__.py b/flaschengeist/__init__.py
index 8980c61..8a5e19e 100644
--- a/flaschengeist/__init__.py
+++ b/flaschengeist/__init__.py
@@ -1,8 +1,4 @@
-""" Server-package
-
-    Initialize app, CORS, database and add it to the application.
-
-"""
+"""Flaschengeist"""
 import logging
 import pkg_resources
 from pathlib import Path
@@ -10,5 +6,7 @@ from werkzeug.local import LocalProxy
 
 __version__ = pkg_resources.get_distribution("flaschengeist").version
 _module_path = Path(__file__).parent
+__pdoc__ = {}
 
 logger: logging.Logger = LocalProxy(lambda: logging.getLogger(__name__))
+__pdoc__["logger"] = "Flaschengeist's logger instance (`werkzeug.local.LocalProxy`)"
diff --git a/flaschengeist/controller/__init__.py b/flaschengeist/controller/__init__.py
index e69de29..9967031 100644
--- a/flaschengeist/controller/__init__.py
+++ b/flaschengeist/controller/__init__.py
@@ -0,0 +1 @@
+"""Basic controllers for interaction with the Flaschengeist core"""
diff --git a/flaschengeist/controller/userController.py b/flaschengeist/controller/userController.py
index c1de6d8..2ab781a 100644
--- a/flaschengeist/controller/userController.py
+++ b/flaschengeist/controller/userController.py
@@ -99,7 +99,7 @@ def set_roles(user: User, roles: list[str], create=False):
         roles: List of role names
         create: If set to true, create not existing roles
     Raises:
-        BadRequest if invalid arguments given or not all roles found while `create` is set to false 
+        BadRequest if invalid arguments given or not all roles found while *create* is set to false
     """
     from roleController import create_role
 
diff --git a/flaschengeist/utils/__init__.py b/flaschengeist/utils/__init__.py
index e69de29..d85bd72 100644
--- a/flaschengeist/utils/__init__.py
+++ b/flaschengeist/utils/__init__.py
@@ -0,0 +1 @@
+"""Common utilities"""