From 27345d5b720520302496c81b75d3c0a2e5b30ca2 Mon Sep 17 00:00:00 2001 From: Robert Newson Date: Sat, 22 Apr 2023 11:30:25 +0100 Subject: doc linting --- src/docs/src/api/ddoc/nouveau.rst | 8 ++++---- src/docs/src/ddocs/nouveau.rst | 20 ++++++++++++-------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/src/docs/src/api/ddoc/nouveau.rst b/src/docs/src/api/ddoc/nouveau.rst index 61f960322..fb6731a5b 100644 --- a/src/docs/src/api/ddoc/nouveau.rst +++ b/src/docs/src/api/ddoc/nouveau.rst @@ -52,10 +52,10 @@ :query string query: Required. The Lucene query string. :query json ranges: This field defines ranges for numeric search fields. The value is a JSON object where the fields names are numeric search fields, - and the values of the fields are arrays of JSON objects. The objects must have a - ``label``, ``min`` and ``max`` value (of type string, number, number respectively), - and optional ``min_inclusive`` and ``max_inclusive`` properties (defaulting to - ``true`` if not specified). + and the values of the fields are arrays of JSON objects. The objects + must have a ``label``, ``min`` and ``max`` value (of type string, + number, number respectively), and optional ``min_inclusive`` and + ``max_inclusive`` properties (defaulting to ``true`` if not specified). Example: ``{"bar":[{"label":"cheap","min":0,"max":100}]}`` :query json sort: Specifies the sort order of the results. The default sort order is relevance. A JSON string of the form diff --git a/src/docs/src/ddocs/nouveau.rst b/src/docs/src/ddocs/nouveau.rst index 94e88ed56..7a9e6d217 100644 --- a/src/docs/src/ddocs/nouveau.rst +++ b/src/docs/src/ddocs/nouveau.rst @@ -12,16 +12,17 @@ .. _ddoc/nouveau: -.. warning:: - Nouveau is an experimental feature. Future releases might change how the endpoints - work and might invalidate existing indexes. - ======= Nouveau ======= +.. warning:: + Nouveau is an experimental feature. Future releases might change how the endpoints + work and might invalidate existing indexes. + Nouveau indexes enable you to query a database by using the -`Lucene Query Parser Syntax. `_ +`Lucene Query Parser Syntax. `_ A nouveau index uses one, or multiple, fields from your documents. You can use a nouveau index to run queries to find documents based on the content they contain. @@ -419,7 +420,8 @@ When more than one result might be returned, it is possible for them to be sorte default, the sorting order is determined by 'relevance'. Relevance is measured according to `Apache Lucene Scoring -`_. +`_. As an example, if you search a simple database for the word ``example``, two documents might contain the word. If one document mentions the word ``example`` 10 times, but the second document @@ -471,7 +473,8 @@ Query syntax ============ The CouchDB search query syntax is based on the -`Lucene syntax. `_ +`Lucene syntax. `_ Search queries take the form of ``name:value`` unless the name is omitted, in which case they use the default field, as demonstrated in the following examples: @@ -569,7 +572,8 @@ The response to a search query contains an ``order`` field for each of the resul specified in the ``sort`` parameter. See the :ref:`sort parameter `. If no ``sort`` parameter is included in the query, then the ``order`` field contains the `Lucene relevance score -`_. +`_. .. _ddoc/nouveau/faceting: -- cgit v1.2.1