summaryrefslogtreecommitdiff
path: root/tools/format_docs_code.py
diff options
context:
space:
mode:
Diffstat (limited to 'tools/format_docs_code.py')
-rw-r--r--tools/format_docs_code.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/tools/format_docs_code.py b/tools/format_docs_code.py
index 8f0b6e54d..6ef7a3080 100644
--- a/tools/format_docs_code.py
+++ b/tools/format_docs_code.py
@@ -1,3 +1,10 @@
+"""Format the code blocks in the documentation using black.
+
+this script parses the documentation files and runs black on the code blocks
+that it extracts from the documentation.
+
+.. versionadded:: 2.0
+"""
from argparse import ArgumentParser
from argparse import RawDescriptionHelpFormatter
from collections.abc import Iterator