Uh oh!
There was an error while loading. Please reload this page.
[docs] Update glossary - daily scan - #8089
Conversation
AwesomeAssertions was bumped from 9.3.0 to 9.4.0 (PR #8008) and is the mandated assertion library for this project's test suites. Adding a glossary entry to explain its purpose and relationship to FluentAssertions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation to the glossary clarifying what AwesomeAssertions is and why it’s used in this repository’s test code, in response to the recent dependency bump.
Changes:
- Add a new glossary entry for AwesomeAssertions, including a brief description and a NuGet link.
Show a summary per file
| File | Description |
|---|---|
| docs/glossary.md | Adds an “AwesomeAssertions” glossary entry explaining its role in the repo’s test assertions. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
Uh oh!
There was an error while loading. Please reload this page.
Amaury Levé (Evangelink)
left a comment
There was a problem hiding this comment.
Summary
Workflow: PR Nitpick Reviewer
Date: 2026-05-11
Repository: microsoft/testfx
Key Findings
- Important – Alphabetical ordering (
docs/glossary.md, line 7):AwesomeAssertionsis inserted beforeArgumentArity, but alphabetically it belongs betweenArgumentArityandAzureDevOpsReport. - Minor – Inconsistent backtick formatting (
docs/glossary.md, line 9):FluentAssertionsis backtick-formatted on its first mention but plain text on the second mention in the same sentence.
Positive Highlights
The entry itself is well-written and informative — it covers what the library is, its API style, its provenance as a FluentAssertions fork, and how its use is enforced via BannedSymbols.txt. Good addition to the glossary.
Recommendations
- Move the new
### AwesomeAssertionsblock to sit between### ArgumentArityand### AzureDevOpsReportin the## Asection. - Make
FluentAssertionsconsistently formatted (either always backtick-code or always plain) within the description paragraph.
Generated by PR Nitpick Reviewer
🔍 Meticulously inspected by PR Nitpick Reviewer 🔍
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
AwesomeAssertions was bumped from 9.3.0 to 9.4.0 (PR #8008) and is the
mandated assertion library for this project's test suites. Adding a
glossary entry to explain its purpose and relationship to FluentAssertions.
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com