adjusted imperfections

README.md

@@ -1,25 +1,10 @@
-# OMD Template
-
-Obsidian Mkdocs export to github.io with [Dracula](https://draculatheme.com) theme.
+# Obsidian Mkdocs Dracula (OMD) Template
 
-Using the following python markdown and mkdocs extensions:
 
-- pymdown-extensions
-- mkdocs-material
-- mkdocs-charts-plugin
-- mkdocs-markmap
-- mkdocs-roamlinks-plugin
-- mkdocs-callouts
-- mkdocs-git-revision-date-localized-plugin
-- mkdocstrings[python]
+Obsidian Mkdocs [Dracula](https://draculatheme.com) template test site.
 
-(extensions correspond to Obsidian plugin used, see requirements.txt for list.)
+Template is a private template for personal/internal use.
 
-Dracula theme inspired by [facelessuser](https://github.com/facelessuser)
-(see theme in action [here](https://facelessuser.github.io/pymdown-extensions/)).
+Obsidian needs fitting. with a few plugins.
 
-Mkdocs Dracula color scheme is an adjustment of Mkdocs material slate theme.
-It is available as a [package](https://github.com/facelessuser/mkdocs_pymdownx_material_extras),
-sources in [this package](https://facelessuser.github.io/pymdown-extensions/).
-
-Dracula is a dark theme only. Dracula can't stand the light.
+Accessory tools used for graphing like Vega (or Vega Lite), or draw.io.

mkdocs.yml

@@ -8,11 +8,12 @@
 #
 site_name: Obsidian MkDocs Test Site
 
+site_description: Test site for Obsidian + Mkdocs + Dracula (OMD) template
+
 site_url: https://devleaks.github.io/omd-sandbox
 repo_url: https://github.com/devleaks/omd-sandbox
 edit_uri: tree/master/docs/
 
-site_description: Test site for Obsidian + Mkdocs + Dracula (OMD) template
 copyright: Copyright &copy; 2024 <a href="https://github.com/devleaks"  target="_blank" rel="noopener">Pierre M</a>
 
 # ###############################################

src/mathematics/factorial.py

@@ -9,13 +9,13 @@ def factorial(n: int) -> int:
         n: number to factor, must be an non negative integer value.
 
     Raises:
-        ValueError: is not a positive integer
+        ValueError: supplied argument is not zero or or a positive integer.
 
     Returns:
         factorial of supplied integer argument.
 
     Warning:
-        Value can become quite large quickly.
+        Value can quickly become quite large.
 
     Examples:
         ```python

src/people/person.py

@@ -2,19 +2,19 @@ class Person:
     """A class to represent a person.
 
     Attributes:
-        name : str
+        name str:
             first name of the person
-        surname : str
+        surname str:
             family name of the person
-        age : int
+        age int:
             age of the person
 
     Methods:
         info(additional=""):
             Prints the person's name and age.
     """
 
-    def __init__(self, name: str, surname: str, age: int):
+    def __init__(self, name: str, surname: str, age: int) -> None:
         """Constructs all the necessary attributes for the person object.
 
         A person object.
@@ -23,9 +23,6 @@ def __init__(self, name: str, surname: str, age: int):
             name: first name of the person
             surname: family name of the person
             age: age of the person
-
-        Returns:
-            None
         """
 
         self.name = name
@@ -35,13 +32,10 @@ def __init__(self, name: str, surname: str, age: int):
     def info(self, additional: str = ""):
         """Prints the person's name and age.
 
-        If the argument 'additional' is passed, then it is appended after the main info.
+        If the argument additional is passed, then it is appended after the main info.
 
         Args:
-            additional, optional: More info to be displayed (default is None) (default: `""`)
-
-        Returns:
-            None
+            additional: More info to be displayed (optional, default is None)
         """
 
         print(