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

Enable PSSA to check for missing function comments #1489

Open
1 task
james-garriss opened this issue Dec 24, 2024 · 0 comments · May be fixed by #1492
Open
1 task

Enable PSSA to check for missing function comments #1489

james-garriss opened this issue Dec 24, 2024 · 0 comments · May be fixed by #1492
Assignees
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@james-garriss
Copy link
Collaborator

💡 Summary

PowerShell functions should have help comments. This issue enables PSSA to check for the existence of the functions, though not the syntax.

Motivation and context

Good programmers document their code. Bad programmers make excuses.

Implementation notes

  • Update the PSSA config

Acceptance criteria

How do we know when this work is done?

  • The CI and workflow pipelines will report functions that have missing help comments.
@james-garriss james-garriss added the enhancement This issue or pull request will add new or improve existing functionality label Dec 24, 2024
@james-garriss james-garriss added this to the Lionfish milestone Dec 24, 2024
@james-garriss james-garriss self-assigned this Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant