diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 23:32:42 +0200 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 23:52:20 +0200 |
| commit | cf2fe9be89aece7d7e44c0b86a8fc854f9895123 (patch) | |
| tree | fa99a8d4e6db848a61ae525773e12263a1533270 /doc/exts | |
| parent | 365e690f4824c250972138e4e01d851067f17984 (diff) | |
| download | pylint-git-cf2fe9be89aece7d7e44c0b86a8fc854f9895123.tar.gz | |
[doc] Add a check for partially completed documentation
Diffstat (limited to 'doc/exts')
| -rw-r--r-- | doc/exts/pylint_messages.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/exts/pylint_messages.py b/doc/exts/pylint_messages.py index d83daf83a..0e5f13872 100644 --- 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 |