Skip to content

GDScript: Document @warning_ignore_start and @warning_ignore_restore #10437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _extensions/gdscript.py
Original file line number Diff line number Diff line change
@@ -428,6 +428,8 @@ def innerstring_rules(ttype):
"@static_unload",
"@tool",
"@warning_ignore",
"@warning_ignore_restore",
"@warning_ignore_start",
),
prefix=r"(?<!\.)",
suffix=r"\b",
16 changes: 11 additions & 5 deletions tutorials/scripting/gdscript/warning_system.rst
Original file line number Diff line number Diff line change
@@ -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