From 8ea7bd94556476d60740d3ccf28bd7f8ce7bca46 Mon Sep 17 00:00:00 2001
From: Mark <mah@optoceutics.com>
Date: Fri, 26 Jan 2024 11:32:44 +0100
Subject: [PATCH] Add module docstring

---
 .github/update_readme.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/.github/update_readme.py b/.github/update_readme.py
index fc23c2a..e351de6 100644
--- a/.github/update_readme.py
+++ b/.github/update_readme.py
@@ -1,3 +1,18 @@
+"""
+Module to run on github to gather stubs for README
+
+Loads `.stub` files from /documentation and compiles them
+to a single string. Then, the string is scanned
+for h2 and h3 markdown headers which are enriched with
+html tags for hyperlinking, and a table of contents is
+created with these headers and hyperlinks and inserted
+into the str.
+
+Finally, the string is written to a complete README.md file.
+
+See the workflow defined in /.github/workflows/main.yaml
+"""
+
 from re import search, findall
 
 def _update_readme(readme: str) -> str: