Browse Source

Merge pull request #2766 from Kaligule/patch-3

Document all comments that disable warnings
Rémi Verschelde 5 years ago
parent
commit
219b3f91f4
1 changed files with 5 additions and 1 deletions
  1. 5 1
      getting_started/scripting/gdscript/static_typing.rst

+ 5 - 1
getting_started/scripting/gdscript/static_typing.rst

@@ -327,7 +327,7 @@ script editor’s status bar. The example below has 3 warnings:
    warning system example
    warning system example
 
 
 To ignore specific warnings in one file, insert a special comment of the
 To ignore specific warnings in one file, insert a special comment of the
-form ``#warning-ignore:warning-id``, or click on the ignore link to the
+form ``# warning-ignore:warning-id``, or click on the ignore link to the
 right of the warning’s description. Godot will add a comment above the
 right of the warning’s description. Godot will add a comment above the
 corresponding line and the code won’t trigger the corresponding warning
 corresponding line and the code won’t trigger the corresponding warning
 anymore:
 anymore:
@@ -337,6 +337,10 @@ anymore:
 
 
    warning system ignore example
    warning system ignore example
 
 
+You can also choose to ignore not just one but all warnings of a certain
+type in this file with ``# warning-ignore-all:warning-id``. To ignore all
+warnings of all types in a file add the comment ``# warnings-disable`` to it.
+
 Warnings won’t prevent the game from running, but you can turn them into
 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
 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
 all warnings. Head to the ``GDScript`` section of the Project Settings to