From 0b02b9571c0dadad52f0d76995df485ef5b7df88 Mon Sep 17 00:00:00 2001 From: Micky Date: Tue, 16 Jan 2024 18:19:41 +0100 Subject: [PATCH] Add "missing description" tag to constant documentation Revives #85836 Co-Authored-By: krysperz2 <106302189+krysperz2@users.noreply.github.com> --- doc/tools/make_rst.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index 2f6340e57212..4435d5252716 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -68,6 +68,8 @@ "This value is an integer composed as a bitmask of the following flags.", "There is currently no description for this class. Please help us by :ref:`contributing one `!", "There is currently no description for this signal. Please help us by :ref:`contributing one `!", + "There is currently no description for this enum. Please help us by :ref:`contributing one `!", + "There is currently no description for this constant. Please help us by :ref:`contributing one `!", "There is currently no description for this annotation. Please help us by :ref:`contributing one `!", "There is currently no description for this property. Please help us by :ref:`contributing one `!", "There is currently no description for this constructor. Please help us by :ref:`contributing one `!", @@ -1102,6 +1104,14 @@ def make_rst_class(class_def: ClassDef, state: State, dry_run: bool, output_dir: if value.text is not None and value.text.strip() != "": f.write(f"{format_text_block(value.text.strip(), value, state)}") + else: + f.write(".. container:: contribute\n\n\t") + f.write( + translate( + "There is currently no description for this enum. Please help us by :ref:`contributing one `!" + ) + + "\n\n" + ) f.write("\n\n") @@ -1125,6 +1135,14 @@ def make_rst_class(class_def: ClassDef, state: State, dry_run: bool, output_dir: if constant.text is not None and constant.text.strip() != "": f.write(f"{format_text_block(constant.text.strip(), constant, state)}") + else: + f.write(".. container:: contribute\n\n\t") + f.write( + translate( + "There is currently no description for this constant. Please help us by :ref:`contributing one `!" + ) + + "\n\n" + ) f.write("\n\n")