Skip to content

Commit

Permalink
Add more info to improving the command help (#61)
Browse files Browse the repository at this point in the history
Add more info to point out that improving the help for a command is possible, but not by sending a PR here
  • Loading branch information
nohwnd authored Mar 20, 2021
1 parent 11b0bfb commit fa90edd
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ This repository contains the source files used to generate the [pester.dev](http

The website pages are written in markdown files using the `.mdx` format and are located in the `/docs` folder.

🔥 **One exception**: the pages in the "Command Reference" section are auto-generated using Pester's
[Comment Based Help](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.1). Therefore, please do not create pull requests for these command reference pages here but instead, fix the corresponding
Pester Powershell source code (as found inside the [pester/pester](https://github.com/pester/pester)
repository).
🔥 **One exception**: the pages in the "Command Reference" section are auto-generated from Pester's
[Comment Based Help](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.1). Please do not create pull requests for these command reference pages here, but instead fix the corresponding
Pester PowerShell source code in [pester/Pester](https://github.com/pester/pester) repository. For example to change [Invoke-Pester command reference](https://pester.dev/docs/commands/Invoke-Pester), you need to change the help [in this file](https://github.com/pester/Pester/blob/v5.0/src/Pester.ps1#L258-L276).

## Contributing

Expand Down

0 comments on commit fa90edd

Please sign in to comment.