-
Notifications
You must be signed in to change notification settings - Fork 54
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
Sentence case comment linter #534
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dislike this since it does not correctly support the following situations:
- Multi-line comments that start each line with
//
. Lines that continued the previous line's sentence are forced to start with a capital, which IMO is a worse style and less readable. - Comments that start with command names or config entry names are forced to start with a capital, which makes their casing incorrect.
Yep, this sounds reasonable, and easily done. If comments are chained one after another, then, if the previous comment doesn't end with a
For this I don't have a very good solution apart from loading everything from SQF into the script, which would make things very ugly. I'd guess it would be easier to just change the sentence structure so that the commands don't start first. If the first point would be implemented it would, for the most part, remove the requirement for this point. |
Yeah, that should work well.
Could get the command names from the wiki and parse them using a simple regex. |
When merged this pull request will:
*.sqf
,*.cpp
and*.hpp
files (only//
comments are checked)http
/https
)For the future (will not be included in this PR):