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

Do not report errors in the one-line comments that start with "Mdlcode" #193

Open
marinaglancy opened this issue Jan 27, 2025 · 0 comments

Comments

@marinaglancy
Copy link
Member

Mdlcode extension for vscode allows to insert directives https://mdlcode.dev/docs/directives , sometimes they can be too long and sometimes they trigger the "X% valid code" error:

  • Line exceeds 132 characters; contains 143 characters (moodle.Files.LineLength.TooLong)
  • Inline comments must end in full-stops, exclamation marks, or question marks
  • This comment is 60% valid code; is this commented out code?

Can we exclude the comments that start with "Mdlcode" from these checks? I can see that there are a couple of exceptions already:
https://github.com/moodlehq/moodle-cs/blob/main/moodle/Sniffs/Commenting/InlineCommentSniff.php#L296
https://github.com/moodlehq/moodle-cs/blob/main/moodle/Sniffs/Commenting/InlineCommentSniff.php#L438

Thanks in advance

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