TrimarcJake / Locksmith

A small tool built to find and fix common misconfigurations in Active Directory Certificate Services.
https://github.com/TrimarcJake/Locksmith
Other
768 stars 72 forks source link

Update function docs #114

Closed TrimarcJake closed 4 months ago

TrimarcJake commented 4 months ago

Used Copilot to add comment-based help to everything. It's not the best, but it's better than nothing!

TrimarcJake commented 4 months ago

Issue #115 supports this.

github-actions[bot] commented 4 months ago

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
⚠️ COPYPASTE jscpd yes 19 1.97s
⚠️ EDITORCONFIG editorconfig-checker 23 1 0.37s
⚠️ MARKDOWN markdownlint 1 11 0.84s
⚠️ MARKDOWN markdown-link-check 1 9 3.06s
✅ MARKDOWN markdown-table-formatter 1 0 0.42s
⚠️ POWERSHELL powershell 22 15 29.6s
✅ POWERSHELL powershell_formatter 22 0 19.94s
⚠️ REPOSITORY checkov yes 1 11.24s
✅ REPOSITORY gitleaks yes no 0.36s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY grype yes no 13.62s
✅ REPOSITORY secretlint yes no 0.79s
✅ REPOSITORY trivy yes no 5.69s
✅ REPOSITORY trivy-sbom yes no 2.7s
✅ REPOSITORY trufflehog yes no 8.09s
⚠️ SPELL cspell 24 154 4.9s

See detailed report in MegaLinter reports _Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff_

_MegaLinter is graciously provided by OX Security_

TrimarcJake commented 4 months ago

Several of the functions had redundant CmdletBinding and param () blocks added in this PR and need to be removed carefully.

Removed! If they are all gone to your satisfaction, please to be approving.

Style question: what is a good way that we can distinguish commands, their output, and the description text for example blocks? I do like the way that most seem to have a blank link between the example command and the example description. Others have no distinguishing paragraph breaks between the example, the example output, and the description.

We can talk about this in Friday's meeting and decide on a standard. And if there's a definite style guide we want to follow, pls lmk!