docs(misc): Some more documentation fixes
This commit is contained in:
parent
4df7f1cc01
commit
d9be9430db
|
@ -1,8 +1,4 @@
|
||||||
""" Server-package
|
"""Flaschengeist"""
|
||||||
|
|
||||||
Initialize app, CORS, database and add it to the application.
|
|
||||||
|
|
||||||
"""
|
|
||||||
import logging
|
import logging
|
||||||
import pkg_resources
|
import pkg_resources
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
@ -10,5 +6,7 @@ from werkzeug.local import LocalProxy
|
||||||
|
|
||||||
__version__ = pkg_resources.get_distribution("flaschengeist").version
|
__version__ = pkg_resources.get_distribution("flaschengeist").version
|
||||||
_module_path = Path(__file__).parent
|
_module_path = Path(__file__).parent
|
||||||
|
__pdoc__ = {}
|
||||||
|
|
||||||
logger: logging.Logger = LocalProxy(lambda: logging.getLogger(__name__))
|
logger: logging.Logger = LocalProxy(lambda: logging.getLogger(__name__))
|
||||||
|
__pdoc__["logger"] = "Flaschengeist's logger instance (`werkzeug.local.LocalProxy`)"
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
"""Basic controllers for interaction with the Flaschengeist core"""
|
|
@ -99,7 +99,7 @@ def set_roles(user: User, roles: list[str], create=False):
|
||||||
roles: List of role names
|
roles: List of role names
|
||||||
create: If set to true, create not existing roles
|
create: If set to true, create not existing roles
|
||||||
Raises:
|
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
|
from roleController import create_role
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
"""Common utilities"""
|
Loading…
Reference in New Issue