godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

GDScript: Document @warning_ignore_start and @warning_ignore_restore

Browse Source
This commit is contained in:
Danil Alexeev
2024-12-23 22:53:50 +03:00
parent 5eebe5f1fa
commit d610bfdf23
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tutorials/scripting/gdscript/warning_system.rst
View File

@@ -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