From bd70418f580aca60e7e0cfea0c7f71e960fd72ea Mon Sep 17 00:00:00 2001
From: Amine Djeghri <32715913+AmineDjeghri@users.noreply.github.com>
Date: Fri, 3 May 2024 23:18:03 +0200
Subject: [PATCH] Create ruff.toml

---
 docs/unix_workflow/package_example/ruff.toml | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 docs/unix_workflow/package_example/ruff.toml

diff --git a/docs/unix_workflow/package_example/ruff.toml b/docs/unix_workflow/package_example/ruff.toml
new file mode 100644
index 0000000..fe547c0
--- /dev/null
+++ b/docs/unix_workflow/package_example/ruff.toml
@@ -0,0 +1,15 @@
+extend-include = ["*.ipynb"]
+line-length = 100
+
+# read more here https://docs.astral.sh/ruff/settings/#lintpydocstyle
+[lint]
+# Enable all `pydocstyle` rules, limiting to those that adhere to the Google convention via `convention = "google"`
+select = [
+    "D",
+]
+# On top of the Google convention, disable for ex `D417`, which requires documentation for every function parameter.
+ignore = ["D100", "D103", "D417"]
+
+[lint.pydocstyle]
+# Use Google-style docstrings.
+convention = "google"