From d610bfdf23cf92f3c192bcd8119b8a7f8bcd5136 Mon Sep 17 00:00:00 2001 From: Danil Alexeev Date: Mon, 23 Dec 2024 22:53:50 +0300 Subject: [PATCH] GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` --- _extensions/gdscript.py | 2 ++ tutorials/scripting/gdscript/warning_system.rst | 16 +++++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/_extensions/gdscript.py b/_extensions/gdscript.py index 59c99cc3f3a..533732158af 100644 --- a/_extensions/gdscript.py +++ b/_extensions/gdscript.py @@ -428,6 +428,8 @@ def innerstring_rules(ttype): "@static_unload", "@tool", "@warning_ignore", + "@warning_ignore_restore", + "@warning_ignore_start", ), prefix=r"(?` annotation. +You can click on the ignore link to the left of the warning's description. +Godot will add an annotation above the corresponding line and the code +won't trigger the corresponding warning anymore: .. image:: img/typed_gdscript_warning_system_ignore.webp +To ignore multiple warnings in a region within a file, use the +:ref:`@warning_ignore_start ` +and :ref:`@warning_ignore_restore ` +annotations. You can omit ``@warning_ignore_restore`` if you want to ignore +the specified warning types until the end of the file. + Warnings won't prevent the game from running, but you can turn them into errors if you'd like. This way your game won't compile unless you fix all warnings. Head to the ``GDScript`` section of the Project Settings to