Skip to content

docs: document the regex reindex comparator - #234

Merged
SkyeAv merged 1 commit into
feat/reindex-regex-pipelinefrom
regex-based-reindexing
Oct 21, 2026
Merged

SkyeAv merged 1 commit into
feat/reindex-regex-pipelinefrom
regex-based-reindexing

Conversation

@SkyeAv

@SkyeAv SkyeAv commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

docs: document the regex reindex comparator

Documents the regex reindex comparator (#232, #233) in the config reference, the example gallery, and the changelog.

Docs

  • Config reference: a regex row in the Reindexing (Conditional Filtering) field table in docs/configuration/table.md (the docs field-table guard reads this table against the live Reindex.model_fields), plus a prose subsection covering the Rust regex dialect (no backreferences, no lookarounds, (?i) flags work), unanchored str.contains semantics, text-typed comparison, null behaviour, and the config-time guards with their error codes.
  • Example gallery: the conditional-filtering example in docs/examples.md drops its placeholder gene cells with one anchored pattern, with a key-technique bullet on anchoring and backwards compatibility.
  • Changelog: the feature under ## Unreleased in CHANGELOG.md, matching the release flow (the release commit renames that heading).

Testing

  • uv run pytest tests/test_docs_source_of_truth.py tests/test_docs_style.py tests/test_docs_examples.py -n 0 --no-cov -q -> 213 passed.
  • npx -y markdownlint-cli2@0.23.3 -> 0 issues in 0 files.
  • uv run --no-sync mkdocs build --strict -> builds clean.

@SkyeAv
SkyeAv added this pull request to stack #235 October 21, 2026 21:09
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 095d2d27-6c9a-412e-b3dd-7d514cdfaf90
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Table config reference: a regex row in the Reindexing field table plus a prose
subsection covering the dialect (Rust regex, no backreferences or lookarounds),
unanchored str.contains semantics, text-typed comparison, null behaviour, the
config-time guards, and the default false. Example gallery: the conditional
filtering config drops its placeholder gene cells with one anchored pattern.
CHANGELOG: the feature under Unreleased.
@SkyeAv
SkyeAv force-pushed the regex-based-reindexing branch from d8b9e15 to 022e1cc Compare October 21, 2026 21:43
@SkyeAv
SkyeAv merged commit bc82084 into main Oct 21, 2026
6 of 11 checks passed
SkyeAv added a commit that referenced this pull request Oct 22, 2026
Cut 22.2.0 and bump the package version in pyproject.toml,
CITATION.cff, and uv.lock.

Minor: the --qc study stage fails the build on self-referential
edges via a new self-loop-edges assertion (#229); eq/ne reindex
filters can match cells with a Polars regex behind a default-off
regex key (#232, #233, #234); source.reindex can filter rows by
identifier membership with join/antijoin semi/anti hash joins
(#236). Docs: the Taxon Filtering link in the table config
reference now matches its section (#228, #231).

Changelog:
- Versioned the Unreleased section as 22.2.0 - 2026-10-22.
- Added PR links to the three Added entries (#229; #232, #233,
  #234; #236).
- Added the missing Fixed entry for the Taxon Filtering docs link
  (#228, #231).

Docs: none needed here; the shipped docs changes are covered by
the changelog entries above.

Testing:
- make check -> ruff, ruff format, pyright, pytest, cargo test,
  cargo clippy -D warnings: all green.
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