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

Add check for non top-level full-sentence comments #33

Open
l0kix2 opened this issue Nov 23, 2023 · 0 comments
Open

Add check for non top-level full-sentence comments #33

l0kix2 opened this issue Nov 23, 2023 · 0 comments

Comments

@l0kix2
Copy link

l0kix2 commented Nov 23, 2023

Hi, godot linter now have three options for scope

#   declarations - for top level declaration comments (default);
#   toplevel     - for top level comments;
#   all          - for all comments.

It would be nice to add one more between all and toplevel. For example (from google style guild https://google.github.io/styleguide/go/decisions#comment-sentences)

type Server struct {
    // BaseDir points to the base directory under which Shakespeare's works are stored
    baseDir string
}

doesn't trigger linter error about dot in the end of line now
Though i think it is rather normal to expect comments for struct fields to be full sentences and it would be nice to have linter validate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant