From 513f22851f677264d66213adcdd74e4992aae17f Mon Sep 17 00:00:00 2001
From: Simon Willison <swillison@gmail.com>
Date: Sat, 23 Nov 2024 12:29:57 -0800
Subject: [PATCH] Docs for table.search(include_rank)

Refs https://github.com/simonw/sqlite-utils/pull/628#issuecomment-2495644255
---
 docs/python-api.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/python-api.rst b/docs/python-api.rst
index 4b446bb..2333d7f 100644
--- a/docs/python-api.rst
+++ b/docs/python-api.rst
@@ -2308,6 +2308,9 @@ The ``.search()`` method also accepts the following optional parameters:
 ``where_args`` dictionary
     Arguments to use for ``:param`` placeholders in the extra WHERE clause
 
+``include_rank`` bool
+    If set a ``rank`` column will be included with the BM25 ranking score - for FTS5 tables only.
+
 ``quote`` bool
     Apply :ref:`FTS quoting rules <python_api_quote_fts>` to the search query, disabling advanced query syntax in a way that avoids surprising errors.