Skip to content

Commit 5647932

Browse files
Small documentation updates (#127)
- Add link to cohere user guide - Add logging on docs build - Fix indentation issue in doc string
1 parent 2058348 commit 5647932

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
import sys
1515
sys.path.insert(0, os.path.abspath('.'))
1616

17+
print(f"Sphinx is using Python executable at: {sys.executable}", flush=True)
18+
print(f"Python version: {sys.version}", flush=True)
19+
1720
# -- Project information -----------------------------------------------------
1821

1922
project = 'RedisVL'

docs/user_guide/vectorizers_04.ipynb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,13 @@
382382
"print(test[:10])"
383383
]
384384
},
385+
{
386+
"cell_type": "markdown",
387+
"metadata": {},
388+
"source": [
389+
"Learn more about using RedisVL and Cohere together through [this dedicated user guide](https://docs.cohere.com/docs/redis-and-cohere)."
390+
]
391+
},
385392
{
386393
"cell_type": "markdown",
387394
"metadata": {},

redisvl/index/index.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,8 @@ def paginate(self, query: BaseQuery, page_size: int = 30) -> Generator:
616616
TypeError: If the page_size argument is not of type int.
617617
ValueError: If the page_size argument is less than or equal to zero.
618618
619-
Example:
619+
.. code-block:: python
620+
620621
# Iterate over paginated search results in batches of 10
621622
for result_batch in index.paginate(query, page_size=10):
622623
# Process each batch of results
@@ -993,7 +994,8 @@ async def paginate(self, query: BaseQuery, page_size: int = 30) -> AsyncGenerato
993994
TypeError: If the page_size argument is not of type int.
994995
ValueError: If the page_size argument is less than or equal to zero.
995996
996-
Example:
997+
.. code-block:: python
998+
997999
# Iterate over paginated search results in batches of 10
9981000
async for result_batch in index.paginate(query, page_size=10):
9991001
# Process each batch of results

0 commit comments

Comments
 (0)