Skip to content

Commit 61329ce

Browse files
committed
refactor: Remove stopwords_interaction_guide.md references and fix comment
Two improvements: 1. Remove all references to docs/stopwords_interaction_guide.md - Removed from docs/api/query.rst (HybridQuery and TextQuery notes) - Removed from docs/api/schema.rst (replaced with reference to user guide) - Removed from redisvl/query/query.py (TextQuery docstring) - Removed from redisvl/query/aggregate.py (AggregateHybridQuery docstring) - Removed from redisvl/index/index.py (warning message) - Removed from docs/user_guide/11_advanced_queries.ipynb - The notebook already has comprehensive stopwords documentation 2. Fix inaccurate comment about stopwords=None - Updated comment in redisvl/index/index.py to clarify that ANY falsy value (None, False, '', 0, [], etc.) results in an empty set, not just None - This matches the actual implementation in _set_stopwords() which uses 'if not stopwords:' check - Updated warning message to mention 'stopwords=None (or any falsy value)'
1 parent e07376d commit 61329ce

File tree

6 files changed

+126
-148
lines changed

6 files changed

+126
-148
lines changed

docs/api/query.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ HybridQuery
5151
The ``stopwords`` parameter in :class:`HybridQuery` (and :class:`AggregateHybridQuery`) controls query-time stopword filtering (client-side).
5252
For index-level stopwords configuration (server-side), see :class:`redisvl.schema.IndexInfo.stopwords`.
5353
Using query-time stopwords with index-level ``STOPWORDS 0`` is counterproductive.
54-
See the `Stopwords Interaction Guide <../stopwords_interaction_guide.html>`_ for details.
5554

5655

5756
TextQuery
@@ -71,7 +70,6 @@ TextQuery
7170
The ``stopwords`` parameter in :class:`TextQuery` controls query-time stopword filtering (client-side).
7271
For index-level stopwords configuration (server-side), see :class:`redisvl.schema.IndexInfo.stopwords`.
7372
Using query-time stopwords with index-level ``STOPWORDS 0`` is counterproductive.
74-
See the `Stopwords Interaction Guide <../stopwords_interaction_guide.html>`_ for details.
7573

7674

7775
FilterQuery

docs/api/schema.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ the ``stopwords`` field. This controls which words are filtered during indexing
6565
**Important Notes:**
6666

6767
- Index-level stopwords affect what gets indexed (server-side)
68-
- Query-time stopwords (in :class:`TextQuery`) affect what gets searched (client-side)
68+
- Query-time stopwords (in :class:`TextQuery` and :class:`AggregateHybridQuery`) affect what gets searched (client-side)
6969
- Using query-time stopwords with index-level ``STOPWORDS 0`` is counterproductive
7070

7171
For detailed information about stopwords configuration and best practices, see the
72-
`Stopwords Interaction Guide <../stopwords_interaction_guide.html>`_.
72+
Advanced Queries user guide (``docs/user_guide/11_advanced_queries.ipynb``).
7373

7474

7575
Defining Fields

0 commit comments

Comments
 (0)