You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update existing PowerShell code to apply project rules of style more consistently. While automation checks for many of the rules we have, some are not. In particular, not all powershell includes docstrings for defined functions that allows developers to easily understand what a function does and use Get-Help to bring up function documentation.
Motivation and context
Improved readability and maintainability of the ScubaGear PowerShell code base.
Implementation notes
Please provide details for implementation, such as:
Check Posh style guide for style gaps not checked by linter already
Review existing Powershell code to ensure all functions have docstrings with synopsis at a minimum
Review PowerShell code for other style gaps
Note gaps for potential inclusion in linter for the future
Acceptance criteria
How do we know when this work is done?
All PowerShell code has been successfully reviewed for adherence to style guide
Any deviations from style guide have been corrected or exempted
Open issues to add style gaps to linter in the future
The text was updated successfully, but these errors were encountered:
💡 Summary
Update existing PowerShell code to apply project rules of style more consistently. While automation checks for many of the rules we have, some are not. In particular, not all powershell includes docstrings for defined functions that allows developers to easily understand what a function does and use Get-Help to bring up function documentation.
Motivation and context
Improved readability and maintainability of the ScubaGear PowerShell code base.
Implementation notes
Please provide details for implementation, such as:
Acceptance criteria
How do we know when this work is done?
The text was updated successfully, but these errors were encountered: