You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by "glynnbird (via GitHub)" <gi...@apache.org> on 2023/05/04 12:43:19 UTC
[GitHub] [couchdb] glynnbird opened a new pull request, #4572: Nouveau doc fixes
glynnbird opened a new pull request, #4572:
URL: https://github.com/apache/couchdb/pull/4572
## Overview
Documentation fixes for the Nouveau feature.
- Ensures all code examples have the data type as the first parameter to `index`.
- Removes `query=` and replaces with `q=`.
- Adds syntax for enabling faceting for selected fields.
## Testing recommendations
n/a
## Related Issues or Pull Requests
n/a
## Checklist
- [x] Documentation changes were made in the `src/docs` folder
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [couchdb] glynnbird merged pull request #4572: Nouveau doc fixes
Posted by "glynnbird (via GitHub)" <gi...@apache.org>.
glynnbird merged PR #4572:
URL: https://github.com/apache/couchdb/pull/4572
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [couchdb] rnewson commented on a diff in pull request #4572: Nouveau doc fixes
Posted by "rnewson (via GitHub)" <gi...@apache.org>.
rnewson commented on code in PR #4572:
URL: https://github.com/apache/couchdb/pull/4572#discussion_r1184964593
##########
src/docs/src/ddocs/nouveau.rst:
##########
@@ -606,8 +609,8 @@ using a single ``if`` statement.
.. code-block:: javascript
if (typeof doc.town == "string" && typeof doc.name == "string") {
- index("string", "town", doc.town);
- index("string", "name", doc.name);
+ index("string", "town", doc.town, { facet: true });
Review Comment:
facet:true isn't recognised, all strings and doubles are indexed for faceting now.
##########
src/docs/src/ddocs/nouveau.rst:
##########
@@ -584,13 +584,16 @@ Nouveau Search also supports faceted searching, enabling discovery of aggregate
information about matches quickly and easily. You can match all documents by using the
special ``?q=*:*`` query syntax, and use the returned facets to refine your query.
-*Example of search query:*
+*Example of faceted index:*
.. code-block:: javascript
function(doc) {
- index("string", "type", doc.type);
- index("double", "price", doc.price);
+ // not faceted
+ index("string", "email", doc.email, { facet: false })
Review Comment:
facet:true isn't recognised, all strings and doubles are indexed for faceting now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [couchdb] glynnbird commented on a diff in pull request #4572: Nouveau doc fixes
Posted by "glynnbird (via GitHub)" <gi...@apache.org>.
glynnbird commented on code in PR #4572:
URL: https://github.com/apache/couchdb/pull/4572#discussion_r1184969055
##########
src/docs/src/ddocs/nouveau.rst:
##########
@@ -584,13 +584,16 @@ Nouveau Search also supports faceted searching, enabling discovery of aggregate
information about matches quickly and easily. You can match all documents by using the
special ``?q=*:*`` query syntax, and use the returned facets to refine your query.
-*Example of search query:*
+*Example of faceted index:*
.. code-block:: javascript
function(doc) {
- index("string", "type", doc.type);
- index("double", "price", doc.price);
+ // not faceted
+ index("string", "email", doc.email, { facet: false })
Review Comment:
Doh. Will remove that commit :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org