Documentation for #warning-ignore and friends

[snoopdouglas]

Your Godot version: 3.2

Issue description:

TLDR: document #warning-ignore, #warning-ignore-all and #warnings-disable.

Apologies if there's already an issue or two out there for this; I've trawled issues for both this repo and the engine's (both open and closed), and haven't been able to find anything.

So yeah, I can't find any reference documentation on the above warning exemptions. (I don't even know if there's an official term for them!)

From what I can see, the only places in the documentation where they're mentioned are:

• Static typing
• VR starter tutorial part 1

With some creative searching, I've been able to produce this list from the in-editor docs:

However, using those identifiers doesn't always seem to work:

[snoopdouglas]

I've found a way to fix the above, but in the process have discovered some weird behaviour on this that I'm going to note here for anyone who might pick this up:

• Warning IDs are snake_cased, despite the static typing tutorial making out they're kebab-cased:

• If you break the rules twice on one line, you have to put two consecutive warning exemption lines (see below)!

• The docs all put a space after the #, but this is actually not required.
• As you can see above, indentation is ignored (though this is what I'd expect with anything involving a comment).

[snoopdouglas]

I've just realised the warning triangle, when clicked, provides the facility to ignore warnings. This isn't mentioned anywhere in the docs though; the closest the static typing tutorial comes is:

[Calinou]

PS: The warning list's "ignore" button has been made more prominent in godotengine/godot#39009.

[Mickeon]

@warning_ignore is also an annotation in 4.0. It also comes with its own explanation and tutorial.

[hsandt]

I tried #warning-ignore:integer_division (also integer-division, #warning-ignore-all, # warnings-disable) and none worked in Godot 4.0.2.

However, the new @warning_ignore("integer_division") works!

This means the doc at https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/warning_system.html and any other page using the old #warning are outdated (unless we want to support the older syntax and it's a bug that it doesn't work, but even then we should recommend using the new one).

So while this issue would make sense for Godot 3 in retrospective, Godot 4 doc should always mention @warning_ignore and any variants (but I could only find this one).

Note: https://docs.godotengine.org/en/stable/classes/class_@gdscript.html mentions @warning_ignore but links to https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/warning_system.html which doesn't.