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

Improvements to Comment Based Help Keywords #175

Merged
merged 1 commit into from Mar 17, 2021

Conversation

msftrncs
Copy link
Contributor

Fixes #136

This PR improves the scoping of comment based help keywords, specifically fixing the lack of highlighting for the keywords that do not accept arguments when used on single-line comment lines.

This required an optimization to the single-line comment (commentLine), and tweaks to the commentEmbeddedDocs matches. By utilizing a ^|\G pattern, it can be prevented that extra # be still permitted to match, which PowerShell does not permit. I also organized the keywords on their prospective matches alphabetically. On the match for keywords with arguments, I opened up the argument capture to all the available text, as there seems to be no additional rules that limit what PowerShell will accept.

There are no tests that cover this particular condition, since the testing engine uses single-line comments to hide the test expressions. commentBlock tests have not changed.

I am sure that #134 has not been reintroduced.

optimize single line comment
use \G in and optimize commentEmbeddedDocs matches
@msftrncs msftrncs mentioned this pull request Mar 12, 2021
@andyleejordan andyleejordan merged commit 2fb86c4 into PowerShell:master Mar 17, 2021
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

Successfully merging this pull request may close these issues.

multiple issues detecting documentation keywords
3 participants