Updates to PowerShell help docs

microsoft / winget-cli

WinGet is the Windows Package Manager. This project includes a CLI (Command Line Interface), PowerShell modules, and a COM (Component Object Model) API (Application Programming Interface).

https://learn.microsoft.com/windows/package-manager/

MIT License

23.38k stars 1.46k forks source link

Updates to PowerShell help docs #4781

Closed mdanish-kh closed 2 months ago

mdanish-kh commented 3 months ago

[x] I have signed the Contributor License Agreement.
[x] This pull request is related to an issue
- Closes https://github.com/microsoft/winget-cli/issues/4773

Each change is broken into a separate commit to help with reviewing. Changes include:

Couple more examples for cmdlets
Linter fixes. Majority of them involve newline after a heading & code-fenced blocks wanting a language tag

Microsoft Reviewers: Open in CodeFlow

denelon commented 2 months ago

Several of the "linter" changes don't align with guidance from the PowerShell team. I'll see if I can pull some documentation together to make this a bit easier to follow/understand or coordinate a meeting. I need to add some additional instructions on this for those folks looking to improve the help files.

mdanish-kh commented 2 months ago

I see. I've reverted the lint fixes for now

microsoft / winget-cli

Updates to PowerShell help docs #4781

Microsoft Reviewers: Open in CodeFlow