Skip to content

Clean up YAML blocks for parameters in all cmdlet reference #2179

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

Closed
5 of 7 tasks
sdwheeler opened this issue Mar 14, 2018 · 4 comments
Closed
5 of 7 tasks

Clean up YAML blocks for parameters in all cmdlet reference #2179

sdwheeler opened this issue Mar 14, 2018 · 4 comments
Labels
area-helpsystem Area - Help services (pipeline, get/update-help)

Comments

@sdwheeler
Copy link
Contributor

There are many cases across all of the documentation where information about wildcard support, position number, default values, etc. on the parameters is incorrect. So far we have been correcting these one at a time. We need an automated way to scan the released modules and update the docs accordingly.

Issue Details

Version(s) of document impacted

  • Impacts 6 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not selecting all version of documents

  • The documented feature was introduced in selected version of PowerShell
  • This issue only shows up in selected version of the document
@zjalexander
Copy link
Contributor

see also: #1672, #1258, #1109

@sdwheeler
Copy link
Contributor Author

Does PlatyPS help us here? PlatyPS generates the stub markdown files. We could regenerate them and merge the diffs?

@SteveL-MSFT
Copy link
Contributor

@sdwheeler the good news is that PlatyPS has a Update-MarkdownHelp cmdlet that updates the YAML of the parameters and the syntax. However, after running it, I notice that the Position property starts at index 1 instead of 0 which is currently used in the docs. It seems that 1 is more accurate for human consumption. Will have to fix this as a series of PRs as just updating the PSCore6 ref docs resulted in 263 changed files. If you agree to the indexing, I'll review the changes and submit a PR.

@sdwheeler sdwheeler added the area-helpsystem Area - Help services (pipeline, get/update-help) label Sep 16, 2019
@sdwheeler sdwheeler removed the Pri0 Priority - Highest label May 7, 2021
@sdwheeler
Copy link
Contributor Author

YAML blocks have been manually updated. Work is ongoing to improve PlatyPS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-helpsystem Area - Help services (pipeline, get/update-help)
Projects
None yet
Development

No branches or pull requests

4 participants