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 descriptions for PesterConfiguration sections #2505

Merged
merged 2 commits into from
Jun 17, 2024

Conversation

fflaten
Copy link
Collaborator

@fflaten fflaten commented Jun 15, 2024

PR Summary

Makes configuration section descriptions slightly more verbose to provide basic information.

Before:

PS > New-PesterConfiguration
Run          : Run configuration.
Filter       : Filter configuration
CodeCoverage : CodeCoverage configuration.
TestResult   : TestResult configuration.
Should       : Should configuration.
Debug        : Debug configuration for Pester. ⚠ Use at your own risk!
Output       : Output configuration
TestDrive    : TestDrive configuration.
TestRegistry : TestRegistry configuration.

After:

PS > New-PesterConfiguration

Run          : General runtime options for Pester including tests containers to execute.
Filter       : Filter options to include/exclude tests and blocks in the targeted containers using tags, name or location. Include by default when no include filters are provided. Exclude filters take precedence.
CodeCoverage : Options to enable and configure Pester's code coverage feature.
TestResult   : Export options to output Pester's testresult to knwon file formats like NUnit and JUnit XML.
Should       : Options to control the behavior of the Pester's Should assertions.
Debug        : Debug configuration for Pester. ⚠ Use at your own risk!
Output       : Options to customize the console output generated by Pester.
TestDrive    : Options to configure the TestDrive feature.
TestRegistry : Options to configure the TestRegistry feature. TestRegistry is only available on Windows-systems.

Fix #2279
Related pester/docs#280 (comment)

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)

@fflaten fflaten mentioned this pull request Jun 15, 2024
16 tasks
@nohwnd nohwnd merged commit ec55e36 into pester:main Jun 17, 2024
11 checks passed
@fflaten fflaten deleted the configuration-section-docs branch June 17, 2024 20:15
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 descriptions in configuration object
2 participants