Skip to content
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

Improve operator-help returned from Get-ShouldOperator #1988

Merged
merged 16 commits into from Jun 14, 2021

Conversation

fflaten
Copy link
Collaborator

@fflaten fflaten commented Jun 12, 2021

PR Summary

This PR introduces customized help format for assertion operators. It displays:

  • Name
  • Aliases (if any)
  • Syntax
  • Synopsis
  • Examples

Also cleans up examples in assertions help and fixes broken Should-Throw help.

Before
image

After
image

Fix #1163

PR Checklist

  • PR has meaningful title
  • Summary describes changes
  • PR is ready to be merged
    • If not, use the arrow next to Create Pull Request to mark it as a draft. PR can be marked Ready for review when it's ready.
  • Tests are added/update (if required)
  • Documentation is updated/added (if required)

@nohwnd
Copy link
Member

nohwnd commented Jun 14, 2021

@fflaten is this ready to be merged?

@fflaten
Copy link
Collaborator Author

fflaten commented Jun 14, 2021

If the output looks right, then I'm good with merging 👍 Haven't tested the format at PS3.0 yet, but should work.

@nohwnd nohwnd merged commit 2893564 into pester:main Jun 14, 2021
@fflaten fflaten deleted the assertion-help branch June 14, 2021 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Get-ShouldOperator
2 participants