Skip to content
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

gdlint: Check for docstrings #133

Open
rgson opened this issue Sep 7, 2021 · 1 comment
Open

gdlint: Check for docstrings #133

rgson opened this issue Sep 7, 2021 · 1 comment
Labels
enhancement New feature or request linter

Comments

@rgson
Copy link
Contributor

rgson commented Sep 7, 2021

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.

@Scony
Copy link
Owner

Scony commented Sep 7, 2021

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 Scony added the linter label Sep 7, 2021
@Scony Scony added this to the 4.x milestone Sep 7, 2021
@Scony Scony added the enhancement New feature or request label Mar 21, 2024
@Scony Scony removed this from the 4.x milestone Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request linter
Projects
Status: No status
Development

No branches or pull requests

2 participants