Skip to content

Commit

Permalink
Create ruff.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
AmineDjeghri authored May 3, 2024
1 parent 9dcb2ee commit bd70418
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/unix_workflow/package_example/ruff.toml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit bd70418

Please sign in to comment.