[doc] Add a check for partially completed documentation

Pierre-Sassoulas · Pierre-Sassoulas · commit cf2fe9be89ae · 2022-05-28T23:52:20.000+02:00
diff --git a/doc/exts/pylint_messages.py b/doc/exts/pylint_messages.py
@@ -78,6 +78,9 @@ def _get_message_data(data_path: Path) -> Tuple[str, str, str, str]:
     related = _get_titled_rst(
         title="Related links", text=_get_rst_as_str(related_rst_path)
     )
+    assert (not bad_code and not related) or (
+        "placeholder" not in good_code and "help us make the doc better" not in details
+    ), "Please remove placeholders if you completed the documentation"
     return good_code, bad_code, details, related
 
 

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,9 @@ def _get_message_data(data_path: Path) -> Tuple[str, str, str, str]:`
`78`	`78`	`related = _get_titled_rst(`
`79`	`79`	`title="Related links", text=_get_rst_as_str(related_rst_path)`
`80`	`80`	`)`
	`81`	`+ assert (not bad_code and not related) or (`
	`82`	`+ "placeholder" not in good_code and "help us make the doc better" not in details`
	`83`	`+ ), "Please remove placeholders if you completed the documentation"`
`81`	`84`	`return good_code, bad_code, details, related`
`82`	`85`
`83`	`86`