From 266e2650e65a7771187514a259b55b8b10d0deee Mon Sep 17 00:00:00 2001
From: ivuorinen <ivuorinen@users.noreply.github.com>
Date: Mon, 1 Apr 2024 00:15:01 +0000
Subject: [PATCH] Update cheatsheets

---
 tldr/pydocstyle | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 tldr/pydocstyle

diff --git a/tldr/pydocstyle b/tldr/pydocstyle
new file mode 100644
index 00000000..407a08da
--- /dev/null
+++ b/tldr/pydocstyle
@@ -0,0 +1,37 @@
+---
+syntax: markdown
+tags: [tldr, common]
+source: https://github.com/tldr-pages/tldr.git
+---
+# 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}}`