scrape_docs explain indentation space replacement

JOJ0 · Oct 3, 2024 · 7cfbadf · 7cfbadf
1 parent 9d96193
commit 7cfbadf
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/scrape_docs.py b/scrape_docs.py
@@ -13,10 +13,11 @@
     type=click.Choice(['debug', 'rst', 'csv']), show_choices=True,
     help='''Output format "debug" prints headline level, headline text and the
     scraped link/anchor; "rst" gives a restructuredText formatted hyperlink
-    including space-indentation according to headline levels; "csv" is a
-    two-column comma separated value format that includes the results of "rst"
-    as the left column's contents. Additionally "csv" adds a restructuredText
-    formatted headline above the table''')
+    including indentation according to headline levels. Spaces at the beginning
+    of lines have a special meaning in rst documents, thus the hardcoded
+    replacement marker "|indent|" is used; "csv" is a two-column comma
+    separated value format that includes the results of "rst" as the left
+    column's contents.''')
 @click.argument('URL')
 def scrape(output, url):
     '''Scrape one chapter of Admin API docs and spit out in various formats.