Merge pull request #417 from rackerlabs/disable-more-pydocstyle

cardoe · web-flow · commit db5c1a84b581 · 2024-10-28T14:35:45.000Z
chore: Disable ruff checks for missing documentation in classes and __init__
diff --git a/python/understack-workflows/pyproject.toml b/python/understack-workflows/pyproject.toml
@@ -96,6 +96,8 @@ ignore = [
     "D102",  # don't require docs for every class method
     "D103",  # don't require docs for every function
     "D104",  # don't require docs for every package
+    "D106",  # don't require docs for every nested class
+    "D107",  # don't require docs for __init__
     "D417"   # don't require docs for every function parameter
 ]
 

Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,8 @@ ignore = [`
`96`	`96`	`"D102", # don't require docs for every class method`
`97`	`97`	`"D103", # don't require docs for every function`
`98`	`98`	`"D104", # don't require docs for every package`
	`99`	`+ "D106", # don't require docs for every nested class`
	`100`	`+ "D107", # don't require docs for __init__`
`99`	`101`	`"D417" # don't require docs for every function parameter`
`100`	`102`	`]`
`101`	`103`