Bläddra i källkod

GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore`

Danil Alexeev 7 månader sedan
förälder
incheckning
d610bfdf23
2 ändrade filer med 13 tillägg och 5 borttagningar
  1. 2 0
      _extensions/gdscript.py
  2. 11 5
      tutorials/scripting/gdscript/warning_system.rst

+ 2 - 0
_extensions/gdscript.py

@@ -428,6 +428,8 @@ class GDScriptLexer(RegexLexer):
                         "@static_unload",
                         "@tool",
                         "@warning_ignore",
+                        "@warning_ignore_restore",
+                        "@warning_ignore_start",
                     ),
                     prefix=r"(?<!\.)",
                     suffix=r"\b",

+ 11 - 5
tutorials/scripting/gdscript/warning_system.rst

@@ -23,14 +23,20 @@ script editor's status bar. The example below has 2 warnings:
 
 .. image:: img/typed_gdscript_warning_example.webp
 
-To ignore specific warnings in one file, insert an annotation of the
-form ``@warning_ignore("warning-id")``, or 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:
+To ignore single warnings within a file, use the
+:ref:`@warning_ignore <class_@GDScript_annotation_@warning_ignore>` 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 <class_@GDScript_annotation_@warning_ignore_start>`
+and :ref:`@warning_ignore_restore <class_@GDScript_annotation_@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