From c916cd4697b16815c89600da8b4ff18582046097 Mon Sep 17 00:00:00 2001 From: Jay Bazuzi Date: Thu, 25 Jun 2026 14:10:16 -0700 Subject: [PATCH 1/2] . d Options doc wording --- approvaltests/docs/reference/Options.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/approvaltests/docs/reference/Options.md b/approvaltests/docs/reference/Options.md index 7a8c8fc9..ddc2eeb1 100644 --- a/approvaltests/docs/reference/Options.md +++ b/approvaltests/docs/reference/Options.md @@ -17,12 +17,15 @@ ## Introduction -There are many things you might want to tweak with Approval Tests. `Options` is the entry-point for many of the changes. -It is on all `verify()` methods, as an optional parameter. +ApprovalTests has many `verify...()` functions that need the same optional parameters, of which there are many. Instead of overloading every `verify...()` function in the same way, over and over, we put those options into an `Options` object that all the `verify...()` functions can take as an optional parameter. + +For example: + +snippet: basic_approval_with_file_extension ## Fluent Interface -`Options` utilizes a fluent interface, allowing you to chain together commands. Each returned object is a new copy. +`Options` has a "fluent" interface, allowing you to chain together commands: each returned object is a new copy of `Options` which you can configure futher. For example: From 6006e47987589dfe392e3fb20a614784a9710e02 Mon Sep 17 00:00:00 2001 From: Jay Bazuzi Date: Thu, 25 Jun 2026 14:12:47 -0700 Subject: [PATCH 2/2] Update approvaltests/docs/reference/Options.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --- approvaltests/docs/reference/Options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/approvaltests/docs/reference/Options.md b/approvaltests/docs/reference/Options.md index ddc2eeb1..6a5a7e9e 100644 --- a/approvaltests/docs/reference/Options.md +++ b/approvaltests/docs/reference/Options.md @@ -25,7 +25,7 @@ snippet: basic_approval_with_file_extension ## Fluent Interface -`Options` has a "fluent" interface, allowing you to chain together commands: each returned object is a new copy of `Options` which you can configure futher. For example: +`Options` has a "fluent" interface, allowing you to chain together commands: each returned object is a new copy of `Options` which you can configure further. For example: