From 465701c5c47b6298170f79546d28d3f642c2e194 Mon Sep 17 00:00:00 2001
From: Franco Gil <45880759+realFranco@users.noreply.github.com>
Date: Sun, 31 Mar 2024 08:18:40 -0400
Subject: [PATCH] pydocstyle: add page (#12579)

---
 pages/common/pydocstyle.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 pages/common/pydocstyle.md

diff --git a/pages/common/pydocstyle.md b/pages/common/pydocstyle.md
new file mode 100644
index 0000000000..ffd31561de
--- /dev/null
+++ b/pages/common/pydocstyle.md
@@ -0,0 +1,32 @@
+# pydocstyle
+
+> Statically check Python scripts for compliance with Python docstring conventions.
+> More information: <https://www.pydocstyle.org/en/latest/>.
+
+- Analyze a Python script or all the Python scripts in a specific directory:
+
+`pydocstyle {{file.py|path/to/directory}}`
+
+- Show an [e]xplanation of each error:
+
+`pydocstyle {{-e|--explain}} {{file.py|path/to/directory}}`
+
+- Show [d]ebug information:
+
+`pydocstyle {{-d|--debug}} {{file.py|path/to/directory}}`
+
+- Display the total number of errors:
+
+`pydocstyle --count {{file.py|path/to/directory}}`
+
+- Use a specific configuration file:
+
+`pydocstyle --config {{path/to/config_file}} {{file.py|path/to/directory}}`
+
+- Ignore one or more errors:
+
+`pydocstyle --ignore {{D101,D2,D107,...}} {{file.py|path/to/directory}}`
+
+- Check for errors from a specific convention:
+
+`pydocstyle --convention {{pep257|numpy|google}} {{file.py|path/to/directory}}`