Skip to content

. d Options doc wording#825

Draft
JayBazuzi wants to merge 2 commits into
masterfrom
JayBazuzi/Options-doc
Draft

. d Options doc wording#825
JayBazuzi wants to merge 2 commits into
masterfrom
JayBazuzi/Options-doc

Conversation

@JayBazuzi

@JayBazuzi JayBazuzi commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Clarify and expand the documentation explaining how the Options object works with ApprovalTests verify functions and its fluent interface.

Documentation:

  • Improve the introduction to Options to better describe its role in sharing optional parameters across verify functions.
  • Enhance the fluent interface section with clearer wording and an example reference snippet.

@sourcery-ai

sourcery-ai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refines the Options reference documentation to better explain the purpose of the Options object, how it relates to verify...() functions, and clarifies the description of its fluent interface with an added example snippet reference.

File-Level Changes

Change Details Files
Clarified the introduction of the Options object and its relationship to verify...() functions, including an example snippet reference.
  • Rewrote the introductory paragraph to describe why Options exists and how it avoids repeated overloading of verify...() functions.
  • Explained that Options encapsulates shared optional parameters for verify...() functions.
  • Added a reference to the snippet basic_approval_with_file_extension as an example usage.
approvaltests/docs/reference/Options.md
Improved the explanation of the fluent interface used by Options and connected it to an example snippet.
  • Rephrased the fluent interface description to mention that each chained call returns a new Options instance for further configuration.
  • Clarified that the interface is "fluent" and described the chaining behavior more explicitly.
  • Introduced a lead-in sentence to the existing specify_all_the_options snippet as an example.
approvaltests/docs/reference/Options.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • There’s a typo in the fluent interface paragraph: futher should be further.
  • Consider clarifying the phrase verify...() (e.g., verify*() or explicit examples) to avoid confusion about whether the ellipsis is literal or illustrative.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- There’s a typo in the fluent interface paragraph: `futher` should be `further`.
- Consider clarifying the phrase `verify...()` (e.g., `verify*()` or explicit examples) to avoid confusion about whether the ellipsis is literal or illustrative.

## Individual Comments

### Comment 1
<location path="approvaltests/docs/reference/Options.md" line_range="28" />
<code_context>
 ## 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:

 <!-- snippet: specify_all_the_options -->
</code_context>
<issue_to_address>
**issue (typo):** Typo: "futher" should be "further".

Please correct the misspelling to "further" in this sentence.

```suggestion
`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:
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread approvaltests/docs/reference/Options.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@JayBazuzi JayBazuzi marked this pull request as draft June 25, 2026 22:02
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.

1 participant