Skip to content

Minor Documentation Edits - #446

Open
s-moon wants to merge 10 commits into
pester:mainfrom
s-moon:main
Open

Minor Documentation Edits#446
s-moon wants to merge 10 commits into
pester:mainfrom
s-moon:main

Conversation

@s-moon

@s-moon s-moon commented Aug 13, 2026

Copy link
Copy Markdown

A small number of minor edits to the documentation to improve readability.

s-moon added 9 commits August 13, 2026 16:26
Added "the" for readability.
Added "a" for readability.
Updated version reference.
Comma to colon.
"Passed" should be "passed".
Comma to semi-colon.
New sentence.
Changed for readability.
Added brackets.
Comment thread docs/quick-start.mdx Outdated
Comment thread docs/quick-start.mdx
`Invoke-Pester` can then be used to run the tests in a given test file, and `-Output Detailed` can be used to show every test in the output, no matter if it passed or failed. Otherwise only failed tests, or whole files (when everything passed) are shown.

To learn more, for example how to run multiple test files in one run, continue to the [Usage](usage/file-placement-and-naming) section.
To learn more (for example how to run multiple test files in one run), continue to the [Usage](usage/file-placement-and-naming) section.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads worse for me. Anyone else?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On reflection, I guess this is just a stylistic thing. Both seem fine to me, now, and perhaps didn't need changing.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Not really a right or wrong, but a parenthesis shouldn't be the majority of a sentence imo.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fflaten I would be more than happy to exclude this change. Is it possible for you to edit it out like you did the other commit so that it can be ignored? Is there a better/easier way?

Co-authored-by: Frode Flaten <3436158+fflaten@users.noreply.github.com>
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.

2 participants