Merge pull request #2766 from Kaligule/patch-3

Document all comments that disable warnings
This commit is contained in:
Rémi Verschelde
2019-10-29 12:06:05 +01:00
committed by GitHub

View File

@@ -327,7 +327,7 @@ script editors status bar. The example below has 3 warnings:
warning system example
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 warnings description. Godot will add a comment above the
corresponding line and the code wont trigger the corresponding warning
anymore:
@@ -337,6 +337,10 @@ anymore:
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 wont prevent the game from running, but you can turn them into
errors if youd like. This way your game wont compile unless you fix
all warnings. Head to the ``GDScript`` section of the Project Settings to