This is an automated email from the ASF dual-hosted git repository. vatamane pushed a commit to branch merge-3.4.3 in repository https://gitbox.apache.org/repos/asf/couchdb.git
commit a552bae251d4e7ad9bf9c9bd639a8d7691631aa4 Author: Jamie Bliss <[email protected]> AuthorDate: Mon Feb 17 15:51:40 2025 -0500 Fix up typos and linting --- src/docs/src/api/database/find.rst | 9 ++++----- src/docs/src/ddocs/mango.rst | 18 +++++++++--------- src/docs/src/ddocs/nouveau.rst | 1 - 3 files changed, 13 insertions(+), 15 deletions(-) diff --git a/src/docs/src/api/database/find.rst b/src/docs/src/api/database/find.rst index 0564df2f6..b6837df6a 100644 --- a/src/docs/src/api/database/find.rst +++ b/src/docs/src/api/database/find.rst @@ -346,11 +346,10 @@ built using MapReduce Views. indexes in the same document (similar to views). *Optional* :query string name: Name of the index. If no name is provided, a name will be generated automatically. *Optional* - :query string type: Can be ``"json"``, ``"text"`` (for clouseau), or - ``"nouveau"``. Defaults to ``"json"``. - Text and Nouveau indexes are related to those - features, and are only available if they're installed. - Geospatial indexes will be supported in the future. *Optional* + :query string type: Can be ``"json"``, ``"text"`` (for clouseau), or + ``"nouveau"``. Defaults to ``"json"``. Text and Nouveau indexes are + related to those features, and are only available if those features are + installed. *Optional* :query boolean partitioned: Determines whether a JSON index is partitioned or global. The default value of ``partitioned`` is the ``partitioned`` property of the database. To create a global index on a diff --git a/src/docs/src/ddocs/mango.rst b/src/docs/src/ddocs/mango.rst index 095dd5840..572e0c86e 100644 --- a/src/docs/src/ddocs/mango.rst +++ b/src/docs/src/ddocs/mango.rst @@ -14,7 +14,7 @@ Mango Queries ============= -In addition to :ref:`map/reduce views <viewfun>`, CouchDB supports a expressive +In addition to :ref:`map/reduce views <viewfun>`, CouchDB supports an expressive query syntax called Mango. The mango system consists of two major concepts: @@ -49,7 +49,7 @@ of function or result. * Empty field names (``""``) cannot be queried ("One or more conditions is missing a field name.") * Field names starting with ``$`` cannot be queried ("Invalid operator: $") - * Fields at the root of the document starting with ``_`` cannot be queried + * Fields at the root of the document starting with ``_`` cannot be queried ("Bad special document member: _") .. _find/selectorbasics: @@ -535,9 +535,9 @@ Below is an example used with the primary index (``_all_docs``): **The** ``$text`` **operator** -The ``$text`` operator performs a text search using either a search or nouveau -index. The specifics of the query follow either -:ref:`search syntax <ddoc/search/syntax>` or +The ``$text`` operator performs a text search using either a search or nouveau +index. The specifics of the query follow either +:ref:`search syntax <ddoc/search/syntax>` or :ref:`nouveau syntax <ddoc/nouveau/syntax>` (which both use Lucene and implement the same syntax). @@ -825,7 +825,8 @@ Nouveau Indexes Mango can also interact with the :ref:`Nouveau search system <ddoc/nouveau>`, using the :ref:`$text selector <find/text>` and Nouveau indexes. These indexes -can be queried using either ``$text`` or :http:get:`/{db}/_design/{ddoc}/_nouveau/{index}`. +can be queried using either ``$text`` or +:http:get:`/{db}/_design/{ddoc}/_nouveau/{index}`. Example index: @@ -844,15 +845,14 @@ Example index: } * ``fields``: ``"all_fields"`` or list of objects: - * ``name``: not blank + * ``name``: not blank * ``type``: one of ``"text"``, ``"string"``, ``"number"``, ``"boolean"`` * ``default_analyzer``: Nouveau analyzer to use, defaults to ``"keyword"`` * ``default_field``: boolean or object of ``enabled`` and ``analyzer`` -* ``partial_filter_selector``: A :ref:`selector<find/selectors>`, causing this +* ``partial_filter_selector``: A :ref:`selector<find/selectors>`, causing this to be a :ref:`partial index<find/partial_indexes>` * ``selector``: A :ref:`selector<find/selectors>` - Indexes and Design Documents ---------------------------- diff --git a/src/docs/src/ddocs/nouveau.rst b/src/docs/src/ddocs/nouveau.rst index 028c1f979..d091ca2e8 100644 --- a/src/docs/src/ddocs/nouveau.rst +++ b/src/docs/src/ddocs/nouveau.rst @@ -504,7 +504,6 @@ field in the JSON object in the request body. "limit": 3 } - .. _ddoc/nouveau/syntax: Query syntax
