Enforce summary in first line with pydocstyle

lukasmasuch · lukasmasuch · commit 2c3c0e4e4dc0 · 2020-11-14T15:50:18.000+01:00
diff --git a/setup.cfg b/setup.cfg
@@ -60,8 +60,7 @@ convention = google
 # D105: Missing docstring in magic method
 # D107: Missing docstring in __init__
 # D202: No blank lines allowed after function docstring
-# D212: Multi-line docstring summary should start at the first line
-add_ignore = D100,D101,D102,D103,D104,D105,D107,D202,D212
+add_ignore = D100,D101,D102,D103,D104,D105,D107,D202
 
 [tool:pytest]
 # markers = slow
diff --git a/src/lazydocs/generation.py b/src/lazydocs/generation.py
@@ -807,7 +807,7 @@ def generate_docs(
         remove_package_prefix=remove_package_prefix,
     )
 
-    pydocstyle_cmd = "pydocstyle --convention=google --add-ignore=D100,D101,D102,D103,D104,D105,D107,D202,D212"
+    pydocstyle_cmd = "pydocstyle --convention=google --add-ignore=D100,D101,D102,D103,D104,D105,D107,D202"
 
     for path in paths:
         if os.path.isdir(path):

Original file line number	Diff line number	Diff line change
`@@ -807,7 +807,7 @@ def generate_docs(`
`807`	`807`	`remove_package_prefix=remove_package_prefix,`
`808`	`808`	`)`
`809`	`809`
`810`		`- pydocstyle_cmd = "pydocstyle --convention=google --add-ignore=D100,D101,D102,D103,D104,D105,D107,D202,D212"`
	`810`	`+ pydocstyle_cmd = "pydocstyle --convention=google --add-ignore=D100,D101,D102,D103,D104,D105,D107,D202"`
`811`	`811`
`812`	`812`	`for path in paths:`
`813`	`813`	`if os.path.isdir(path):`