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

Add help comments to all PowerShell functions #1491

Open
1 task
james-garriss opened this issue Dec 24, 2024 · 0 comments
Open
1 task

Add help comments to all PowerShell functions #1491

james-garriss opened this issue Dec 24, 2024 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation

Comments

@james-garriss
Copy link
Collaborator

james-garriss commented Dec 24, 2024

💡 Summary

We currently have 148 PowerShell functions that do not have a help comment. (Major ouch!) This issue is about adding the missing comments. The complete list of functions can be found by running the pipelines. Here's one example:

https://github.com/cisagov/ScubaGear/actions/runs/12484842615/job/34842826197

This issue is a follow-on to #1489.

Motivation and context

Good programmers document their code. Bad programmers make excuses.

Implementation notes

  • Find each function that is missing a help comment.
  • Add a synopsis as a bare minimum.
  • Preferably add complete comment.

Acceptance criteria

How do we know when this work is done?

  • All functions have help comments.
@james-garriss james-garriss added the documentation This issue or pull request improves or adds to documentation label Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

No branches or pull requests

1 participant