Skip to content

[NO ISSUE] Various documentation fixes#43

Merged
TomStrepsil merged 10 commits into
mainfrom
readme-fixes
May 24, 2026
Merged

[NO ISSUE] Various documentation fixes#43
TomStrepsil merged 10 commits into
mainfrom
readme-fixes

Conversation

@TomStrepsil
Copy link
Copy Markdown
Owner

Details

Added some missing details from #42:

  • explaining that searchStrategyFactory cannot return the balanced strategy
  • added the variant balanced strategy to the "meta-strategies" section of the benchmarking README.md
  • various syntactical fixes

Semantic Version Impact

  • PATCH - Bug fixes and minor changes (backwards compatible)
  • MINOR - New features (backwards compatible)
  • MAJOR - Breaking changes (not backwards compatible)

Checklist

  • I have added an entry to the [Unreleased] section in CHANGELOG.md
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copilot AI review requested due to automatic review settings May 24, 2026 17:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 searchStrategyFactory vs 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.

Comment thread src/search-strategies/README.md Outdated
Comment thread src/search-strategies/benchmarking/README.md Outdated
Comment thread README.md
Comment thread docs/CHANGELOG.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 24, 2026 17:39
TomStrepsil and others added 2 commits May 24, 2026 18:40
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

Comment thread src/search-strategies/README.md Outdated
Comment thread src/search-strategies/benchmarking/README.md Outdated
Comment thread README.md
Comment thread docs/CHANGELOG.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread src/search-strategies/benchmarking/README.md Outdated
Comment thread docs/CHANGELOG.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 24, 2026 17:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread src/search-strategies/benchmarking/README.md Outdated
Comment thread README.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 24, 2026 18:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread src/search-strategies/benchmarking/README.md Outdated
Comment thread docs/CHANGELOG.md
@TomStrepsil TomStrepsil merged commit 7aee827 into main May 24, 2026
8 checks passed
@TomStrepsil TomStrepsil deleted the readme-fixes branch May 24, 2026 18:31
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.

2 participants