Skip to content

feat: codex review changes - #12

Merged
ankitml merged 2 commits into
mainfrom
ankitmldesign-doc-review
Feb 4, 2026
Merged

feat: codex review changes#12
ankitml merged 2 commits into
mainfrom
ankitmldesign-doc-review

Conversation

@ankitml

@ankitml ankitml commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

Ticket(s) Closed

Codex reviewed the implementation and requested these changes.

  • Added Migrations section - Documents adding BM25Index to existing models with Django's migration workflow
  • Enhanced Boolean Logic - Clarifies when to use simple AND (ParadeDB('a', 'b')) vs explicit PQ objects for OR/complex logic
  • Expanded Faceted Search - Added requirements, "why these requirements" explanation, and 3 common error scenarios with solutions
  • New Security section - Documents SQL injection protection strategy (escaping vs parameterization) with rationale
  • Type safety improvements - Added @overload signatures to ParadeDB class for better IDE autocomplete and type checking
  • Documentation quality fixes - Fixed casing inconsistencies (ParadeDB vs Paradedb), improved markdown formatting
  • Closes #

What

Why

How

Tests

Comment thread src/paradedb/search.py
# Simple AND search (multiple strings allowed)
ParadeDB('running', 'shoes')

# Boolean logic (PQ must be SOLE argument)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is this a Django requirement?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes. It is how Django's Q objects behave https://docs.djangoproject.com/en/6.0/topics/db/queries/#complex-lookups-with-q
Our PQ object mirrors default Q object.

Comment thread README.md Outdated
@ankitml
ankitml force-pushed the ankitmldesign-doc-review branch from 1167b5a to 4398601 Compare February 4, 2026 02:14
@ankitml
ankitml merged commit 739d07e into main Feb 4, 2026
3 checks passed
@ankitml
ankitml deleted the ankitmldesign-doc-review branch February 4, 2026 02:15
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