From cdc6639447832af8f6ecb81d69dcb1e15e21723e Mon Sep 17 00:00:00 2001
From: Bastian Venthur <venthur@debian.org>
Date: Mon, 22 Mar 2021 10:16:56 +0100
Subject: [PATCH] added markdown docs

---
 blag/markdown.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/blag/markdown.py b/blag/markdown.py
index 5144eb9..4dab425 100644
--- a/blag/markdown.py
+++ b/blag/markdown.py
@@ -1,3 +1,10 @@
+"""Markdown Processing.
+
+This module contains the methods responsible for blag's markdown
+processing.
+
+"""
+
 from datetime import datetime
 import logging
 from urllib.parse import urlsplit, urlunsplit
@@ -34,6 +41,11 @@ def markdown_factory():
 def convert_markdown(md, markdown):
     """Convert markdown into html and extract meta data.
 
+    Some meta data is treated special:
+        * `date` is converted into datetime with local timezone
+        * `tags` is interpreted as a comma-separeted list of strings.
+          All strings are stripped and converted to lower case.
+
     Parameters
     ----------
     md : markdown.Markdown instance
@@ -98,6 +110,9 @@ class MarkdownLinkTreeprocessor(Treeprocessor):
 
 
 class MarkdownLinkExtension(Extension):
+    """markdown.extension that converts relative .md- to .html-links.
+
+    """
     def extendMarkdown(self, md):
         md.treeprocessors.register(
                 MarkdownLinkTreeprocessor(md), 'mdlink', 0,