docs: add 'validate' to documentation

hukkin · Dec 18, 2024 · 1861895 · 1861895
1 parent ddd42ca
commit 1861895
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/users/configuration_file.md b/docs/users/configuration_file.md
@@ -20,6 +20,7 @@ Command line interface arguments take precedence over the configuration file.
 wrap = "keep"         # options: {"keep", "no", INTEGER}
 number = false        # options: {false, true}
 end_of_line = "lf"    # options: {"lf", "crlf", "keep"}
+validate = true       # options: {false, true}
 # extensions = [      # options: a list of enabled extensions (default: all installed are enabled)
 #     "gfm",
 #     "toc",

diff --git a/src/mdformat/_conf.py b/src/mdformat/_conf.py
@@ -8,9 +8,9 @@
 
 DEFAULT_OPTS = {
     "wrap": "keep",
-    "validate": True,
     "number": False,
     "end_of_line": "lf",
+    "validate": True,
     "exclude": [],
     "plugin": {},
     "extensions": None,