From fdb1b0cdad06ff45af8f82a803306f8d807bb912 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Fri, 10 Jan 2025 16:56:21 +0000
Subject: [PATCH] Update documentation for the ``:no-search:`` file-wide
 metadata option

---
 doc/usage/restructuredtext/field-lists.rst | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/doc/usage/restructuredtext/field-lists.rst b/doc/usage/restructuredtext/field-lists.rst
index d352633f46b..b85d94520d1 100644
--- a/doc/usage/restructuredtext/field-lists.rst
+++ b/doc/usage/restructuredtext/field-lists.rst
@@ -68,11 +68,24 @@ At the moment, these metadata fields are recognized:
 
    .. versionadded:: 1.0
 
-``nosearch``
-   If set, full text search for this file is disabled. ::
+``no-search``
+   Disable full text search for this document.
 
-       :nosearch:
+   .. code-block:: rst
 
-   .. note:: object search is still available even if ``nosearch`` option is set.
+      :no-search:
+
+   .. note::
+      The ``:no-search:`` option only disables full text search,
+      meaning that object search will still be available even if
+      ``:no-search:`` is set.
 
    .. versionadded:: 3.0
+
+   .. versionchanged:: 7.3
+
+      The file-wide metadata option ``:nosearch:`` was renamed
+      to ``:no-search:``.
+      The previous name has been retained as an alias,
+      but will be deprecated and removed
+      in a future version of Sphinx.