From 5cdf36029aa832d3b98ca3ff9ede7b9ce724f8a1 Mon Sep 17 00:00:00 2001 From: Robin Greif Date: Tue, 12 Dec 2023 15:01:21 +0000 Subject: [PATCH] Docs: clarify that include requires extra escapes --- pdoc/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pdoc/__init__.py b/pdoc/__init__.py index 3cbfec94..4aff9087 100644 --- a/pdoc/__init__.py +++ b/pdoc/__init__.py @@ -281,6 +281,7 @@ class GoldenRetriever(Dog): ``` Since version 11, pdoc processes such reStructuredText elements by default. +This will process your Markdown file as a Python string, meaning extra backslashes for escape might be required (e.g. linebreaks \\ -> \\\) ## ...add a title page?