From 5c511a00f5e104477c388282ba09b62b73397e80 Mon Sep 17 00:00:00 2001
From: Mo8it <mo8it@proton.me>
Date: Sun, 3 Jul 2022 18:26:15 +0200
Subject: [PATCH] Module doc strings

---
 advlabdb/advlabdb_independent_funs.py         | 4 +++-
 advlabdb/model_dependent_funs.py              | 4 +++-
 advlabdb/model_independent_funs.py            | 4 +++-
 advlabdb/scripts/setup/logged_server_setup.py | 4 +++-
 advlabdb/scripts/setup/server_setup.py        | 4 +++-
 advlabdb/scripts/setup/shared.py              | 4 +++-
 advlabdb/scripts/terminal_utils.py            | 4 +++-
 7 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/advlabdb/advlabdb_independent_funs.py b/advlabdb/advlabdb_independent_funs.py
index 0b94aeb..3fd2c70 100644
--- a/advlabdb/advlabdb_independent_funs.py
+++ b/advlabdb/advlabdb_independent_funs.py
@@ -1,4 +1,6 @@
-# Functions not dependent on advlabdb
+"""
+Functions not dependent on advlabdb.
+"""
 
 from flask import flash, url_for
 from markupsafe import Markup, escape
diff --git a/advlabdb/model_dependent_funs.py b/advlabdb/model_dependent_funs.py
index e2bfeed..8f323bd 100644
--- a/advlabdb/model_dependent_funs.py
+++ b/advlabdb/model_dependent_funs.py
@@ -1,4 +1,6 @@
-# Functions dependent on advlabdb.models
+"""
+Functions dependent on advlabdb.models.
+"""
 
 from functools import cache
 
diff --git a/advlabdb/model_independent_funs.py b/advlabdb/model_independent_funs.py
index e5dcaee..689573e 100644
--- a/advlabdb/model_independent_funs.py
+++ b/advlabdb/model_independent_funs.py
@@ -1,4 +1,6 @@
-# Functions not dependent on advlabdb.models
+"""
+Functions not dependent on advlabdb.models.
+"""
 
 import secrets
 from string import ascii_letters, digits
diff --git a/advlabdb/scripts/setup/logged_server_setup.py b/advlabdb/scripts/setup/logged_server_setup.py
index 327cd11..57756dd 100644
--- a/advlabdb/scripts/setup/logged_server_setup.py
+++ b/advlabdb/scripts/setup/logged_server_setup.py
@@ -1,4 +1,6 @@
-# No relative imports allowed in this file to be able to run server_setup.py without packages
+"""
+No relative imports allowed in this file to be able to run server_setup.py without packages.
+"""
 
 import sys
 from pathlib import Path
diff --git a/advlabdb/scripts/setup/server_setup.py b/advlabdb/scripts/setup/server_setup.py
index 4e28721..db176c4 100644
--- a/advlabdb/scripts/setup/server_setup.py
+++ b/advlabdb/scripts/setup/server_setup.py
@@ -1,4 +1,6 @@
-# No relative imports allowed in this file to be able to run server_setup.py without packages
+"""
+No relative imports allowed in this file to be able to run server_setup.py without packages.
+"""
 
 import sys
 from pathlib import Path
diff --git a/advlabdb/scripts/setup/shared.py b/advlabdb/scripts/setup/shared.py
index df425b0..3c331af 100644
--- a/advlabdb/scripts/setup/shared.py
+++ b/advlabdb/scripts/setup/shared.py
@@ -1,4 +1,6 @@
-# No relative imports allowed in this file to be able to run server_setup.py without packages
+"""
+No relative imports allowed in this file to be able to run server_setup.py without packages.
+"""
 
 import sys
 from pathlib import Path
diff --git a/advlabdb/scripts/terminal_utils.py b/advlabdb/scripts/terminal_utils.py
index f2d93b6..cb2ac98 100644
--- a/advlabdb/scripts/terminal_utils.py
+++ b/advlabdb/scripts/terminal_utils.py
@@ -1,4 +1,6 @@
-# No relative imports allowed in this file to be able to run server_setup.py without packages
+"""
+No relative imports allowed in this file to be able to run server_setup.py without packages.
+"""
 
 import subprocess  # nosec 404
 from getpass import getpass