. d Options doc wording#825
Draft
JayBazuzi wants to merge 2 commits into
Draft
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefines 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- There’s a typo in the fluent interface paragraph:
futhershould befurther. - 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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Clarify and expand the documentation explaining how the Options object works with ApprovalTests verify functions and its fluent interface.
Documentation: