-
Notifications
You must be signed in to change notification settings - Fork 388
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
Fixes #1722 - Update cmdlet docs for 1.20.0 #1726
Conversation
Looks like cmdlet help tests are failing:
|
@rjmholt I checked to see if there were tests. I couldn't find them. I will take another look and fix them. |
@rjmholt I removed the test for Remarks in the example. Remarks are optional. The only thing we need to validate is that there is a code block in the example. |
|
||
# Should be at least one example description | ||
It "gets example help from $commandName" -TestCases $testCases { | ||
($Help.Examples.Example.Remarks | Select-Object -First 1).Text | Should -Not -BeNullOrEmpty | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we're better off not removing tests like this if we can avoid it — it's a nice bar on doc quality that we require examples.
If docs are just being updated, what caused this to fail?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, I wouldn't normally want to remove a test but the Remarks are optional.
The test broke because the Remarks were moved. In some cases, the Remark was incorporated into the Example title. In others it was move before the code block as an intro.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For higher quality, we should be testing the following:
- every parameter of a cmdlet exists in the markdown
- each parameter has description
- the markdown does not contain any parameters that the cmdlet doesn't have
PR Summary
Fixes #1722 - Prepare cmdlet reference for publication on docs.microsoft.com
PR Checklist
.cs
,.ps1
and.psm1
files have the correct copyright headerWIP:
to the beginning of the title and remove the prefix when the PR is ready.