asears
commented
4 years ago Using Pester 5.02 / Powershell 5.1.18362.752 and happy to help with this too, though it's a pretty broad issue to create examples for each command and duplicate the effort both online and in the offline help. I wonder what other module projects have done to automate / synch this?
I see this coming up in PSScriptAnalyzer recurse scan.
ProvideCommentHelp Information Pester.Run 78 The cmdlet 'Find-Test' does not have a help comment.
PSProvideCommentHelp Information Pester.Run 746 The cmdlet 'Is-Discovery' does not have a help comment.
PSProvideCommentHelp Information Pester.Run 1000 The cmdlet 'Invoke-PluginStep' does not have a help comment.
PSProvideCommentHelp Information Pester.Run 1680 The cmdlet 'Invoke-Test' does not have a help comment.
PSProvideCommentHelp Information Pester.Run 2372 The cmdlet 'Recurse-Up' does not have a help comment.
PSProvideCommentHelp Information Pester.Moc 345 The cmdlet 'Public' does not have a help comment.
PSProvideCommentHelp Information InModuleSc 31 The cmdlet 'PublicFunction' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 458 The cmdlet 'PublicFunction' does not have a help comment.
.ps1 not have a help comment.
.ps1 have a help comment.
PSProvideCommentHelp Information Mock.Tests 481 The cmdlet 'PublicFunction' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 484 The cmdlet 'PublicFunction2' does not have a help comment.
.ps1 have a help comment.
PSProvideCommentHelp Information Mock.Tests 494 The cmdlet 'ScopeTest' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 1046 The cmdlet 'PublicFunction' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 1340 The cmdlet 'PublicFunction' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 1352 The cmdlet 'PublicFunction' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2203 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2252 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2265 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2441 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2504 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2555 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2565 The cmdlet 'f' does not have a help comment.
PSProvideCommentHelp Information Mock.Tests 2581 The cmdlet 'f' does not have a help comment.Help works for Invoke-Pester on this machine
get-help invoke-pester
NAME
Invoke-Pester
SYNTAX
Invoke-Pester [[-Path] <string[]>] [-ExcludePath <string[]>] [-TagFilter <string[]>] [-ExcludeTagFilter <string[]>] [-FullNameFilter <string[]>] [-CI] [-Output {Diagnostic | Detailed
| Normal | Minimal | None}] [-PassThru] [<CommonParameters>]
Invoke-Pester [[-Path] <string[]>] [[-FullNameFilter] <string[]>] [[-EnableExit]] [[-TagFilter] <string[]>] [-ExcludeTagFilter <string[]>] [-PassThru] [-CodeCoverage <Object[]>]
[-CodeCoverageOutputFile <string>] [-CodeCoverageOutputFileEncoding <string>] [-CodeCoverageOutputFileFormat {JaCoCo}] [-Strict] [-OutputFile <string>] [-OutputFormat {NUnitXml |
JUnitXml}] [-Quiet] [-PesterOption <Object>] [-Show {None | Default | Passed | Failed | Pending | Skipped | Inconclusive | Describe | Context | Summary | Header | Fails | All}]
[<CommonParameters>]
Invoke-Pester [-Configuration <PesterConfiguration>] [<CommonParameters>]
ALIASES
None
REMARKS
NoneShould -?
NAME
Should
SYNOPSIS
Should is a keyword what is used to define an assertion inside It block.
SYNTAX
Should [[-ActualValue] <Object>] [<CommonParameters>]
DESCRIPTION
Should is a keyword what is used to define an assertion inside the It block.
Should provides assertion methods for verify assertion e.g. comparing objects.
If assertion is not met the test fails and an exception is throwed up.
Should can be used more than once in the It block if more than one assertion
need to be verified. Each Should keywords need to be located in a new line.
Test will be passed only when all assertion will be met (logical conjuction).
RELATED LINKS
https://github.com/pester/Pester/wiki/Should
about_Should
about_Pester
REMARKS
To see the examples, type: "get-help Should -examples".
For more information, type: "get-help Should -detailed".
For technical information, type: "get-help Should -full".
For online help, type: "get-help Should -online"Examples should show examples, but currently doesn't. The online help command redirects to another page and could have the link fixed to direct to correct link.
Some more details on the Pester 5 configuration object, discovery, code coverage and example scripts and documentation for Devops pipelines would be super useful.
jhoneill
nohwnd
ThomasNieto
bravo-kernel
should be
fflaten
1. General summary of the issue
Pester's documentation is not up to the same standard as the rest of the module.
2. Describe Your Environment
PowerShell 5, 7.0.3, Windows Terminal, VS Code,
3. Expected Behavior
Should -?gives valid / useful help.get-help about_ShouldworksInvoke-pester -?returns parameter help.etc.
4.Current Behavior
The remarks are added by the help system but there are no examples. The URL is no longer current. Help for a command shouldn't be in an about topic
This may be a consequence of how about_ help is processed and having multiple pester versions present. Because of syntax changes there may be old and new versions present on a system, VS code installs a version in parallel with any the user has etc.
Invoke-Pesterseems to be missing help entirely.5. Possible Solution
It needs input from more than one person (and I'm happy to be one of the people) to fill in the gaps, make corrections, and generally bring the help up the same standard as a the code. As with PowerShell itself this should include people who wouldn't consider adding to the code.