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

Fix CommentHelp for when a function has other problems with it #1216

Conversation

TylerLeonhardt
Copy link
Member

Fixes PowerShell/vscode-powershell#2516

We weren't specifically telling PSSA to only run the one rule so other diagnostics were coming back. I would guess that this fix would also have some perf impact as well which is nice.

an example bad function that works with this change:

function CanSendGetCommentHelpRequest {
    param(
        $myParam,
        $myOtherParam,
        $yetAnotherParam
    )

    # Include other problematic code to make sure this still works
    gci
}

The test change failed before the code change and passed after the code change.

@rjmholt
Copy link
Contributor

rjmholt commented Mar 3, 2020

Should probably include a changelog entry

@TylerLeonhardt TylerLeonhardt merged commit ca431bb into PowerShell:master Mar 3, 2020
@TylerLeonhardt TylerLeonhardt deleted the fix-comment-help-with-other-problems-in-it branch March 3, 2020 01:39
TylerLeonhardt added a commit that referenced this pull request Mar 3, 2020
* Fix CommentHelp for when a function has other problems with it

* add CL entry
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.

Preview: Autopopulation of comment based help not working
2 participants