Skip line parsing in some sections

Author: staticf0x

docstring_to_markdown/google.py

@@ -2,7 +2,8 @@
 from textwrap import dedent
 from typing import Dict, List, Union
 
-_GOOGLE_SECTIONS: List[str] = [
+# All possible sections in Google style docstrings
+SECTION_HEADERS: List[str] = [
     "Args",
     "Returns",
     "Raises",
@@ -14,6 +15,14 @@
     "Todo",
 ]
 
+# These sections will not be parsed as a list of arguments/return values/etc
+PLAIN_TEXT_SECTIONS: List[str] = [
+    "Examples",
+    "Example",
+    "Note",
+    "Todo",
+]
+
 ESCAPE_RULES = {
     # Avoid Markdown in magic methods or filenames like __init__.py
     r"__(?P<text>\S+)__": r"\_\_\g<text>\_\_",
@@ -30,6 +39,10 @@ def __init__(self, name: str, content: str) -> None:
     def _parse(self, content: str) -> None:
         content = content.rstrip("\n")
 
+        if self.name in PLAIN_TEXT_SECTIONS:
+            self.content = dedent(content)
+            return
+
         parts = []
         cur_part = []
 
@@ -125,15 +138,15 @@ def as_markdown(self) -> str:
 
 
 def is_section(line: str) -> bool:
-    for section in _GOOGLE_SECTIONS:
+    for section in SECTION_HEADERS:
         if re.search(r"{}:".format(section), line):
             return True
 
     return False
 
 
 def looks_like_google(value: str) -> bool:
-    for section in _GOOGLE_SECTIONS:
+    for section in SECTION_HEADERS:
         if re.search(r"{}:\n".format(section), value):
             return True