godot-gdscript-toolkit icon indicating copy to clipboard operation
godot-gdscript-toolkit copied to clipboard

gdlint: Check for docstrings

Open rgson opened this issue 3 years ago • 1 comments

Could gdlint warn about missing docstrings at the top of scripts?

I'm thinking of something similar to pylint's "Missing module docstring (missing-docstring)".

The official style guide recommends adding docstring comment near the top, after tool, class_name and extends.

rgson avatar Sep 07 '21 20:09 rgson

That's too pedantic to add as a regular check, but I agree it will be a pretty cool remark-check. For that, however, we will need check importance levels just like in pylint. So it will be implemented for 4.x.

Scony avatar Sep 07 '21 21:09 Scony