[NO ISSUE] Various documentation fixes#43
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-focused PR that updates library and benchmarking docs to reflect the balanced-pair strategy ecosystem introduced in #42, plus minor wording/formatting corrections.
Changes:
- Clarifies usage guidance around search strategies (including balanced-pair) and updates strategy descriptions.
- Expands benchmarking documentation to include the balanced-pair regex-count meta-strategy.
- Updates root README guidance around
searchStrategyFactoryvs direct strategy imports, and adds changelog entries for the newly documented benchmarking strategy.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/search-strategies/README.md | Tweaks wording/formatting in the search strategies overview and balanced-pair description. |
| src/search-strategies/benchmarking/README.md | Renames “Meta-Strategy” section and adds the balanced-pair regex-count benchmarking strategy entry. |
| README.md | Adds an IMPORTANT note about searchStrategyFactory not returning balanced-pair and adds a balanced-pair usage snippet. |
| docs/CHANGELOG.md | Adds/updates Unreleased entries to reflect documentation changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…-transformer into readme-fixes
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.
Details
Added some missing details from #42:
searchStrategyFactorycannot return the balanced strategyREADME.mdSemantic Version Impact
Checklist
[Unreleased]section inCHANGELOG.md