diff --git a/Documentation/Books/AQL/Functions/Document.mdpp b/Documentation/Books/AQL/Functions/Document.mdpp index 5b35c44175..6bfc05a370 100644 --- a/Documentation/Books/AQL/Functions/Document.mdpp +++ b/Documentation/Books/AQL/Functions/Document.mdpp @@ -176,12 +176,14 @@ comparison with the next example until there are no more examples left. The *examples* can be an array of 1..n example documents or a single document, with any number of attributes each. +Note that *MATCHES()* can not utilize indexes. + - **document** (object): document to determine whether it matches any example - **examples** (object|array): a single document, or an array of documents to compare against. Specifying an empty array is not allowed. - **returnIndex** (bool): by setting this flag to *true*, the index of the example that matched will be returned (starting at offset 0), or *-1* if there was no match. - The default is **false** and makes the function return a boolean. + The default is *false* and makes the function return a boolean. - returns **match** (bool|number): if *document* matches one of the examples, *true* is returned, otherwise *false*. A number is returned instead if *returnIndex* is used. @@ -194,7 +196,7 @@ LET doc = { RETURN MATCHES(doc, { age: 27, active: true } ) ``` -This will return **true**, because all attributes of the example are present in the document. +This will return *true*, because all attributes of the example are present in the document. ```js RETURN MATCHES( @@ -206,8 +208,8 @@ RETURN MATCHES( ], true) ``` - This will return *2*, because the third example matches, and because the - *returnIndex* flag is set to *true*. +This will return *2*, because the third example matches, and because the +*returnIndex* flag is set to *true*. !SUBSECTION MERGE() diff --git a/Documentation/Books/AQL/Functions/String.mdpp b/Documentation/Books/AQL/Functions/String.mdpp index 42168f5553..ff7df48807 100644 --- a/Documentation/Books/AQL/Functions/String.mdpp +++ b/Documentation/Books/AQL/Functions/String.mdpp @@ -303,7 +303,7 @@ characters and sequences: - `(xyz)` – defines and matches a pattern group - `(x|y)` – matches either *x* or *y* - `^` – matches the beginning of the string (e.g. `^xyz`) -- `$` – matches the end of the string (e.g. `xyz$`) +- $ – matches the end of the string (e.g. xyz$) Note that the characters `.`, `*`, `?`, `[`, `]`, `(`, `)`, `{`, `}`, `^`, and `$` have a special meaning in regular expressions and may need to be diff --git a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md index f5cb864397..cfdd7b1285 100644 --- a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md +++ b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md @@ -4,7 +4,7 @@ @RESTHEADER{DELETE /_api/gharial/{graph-name}, Drop a graph} @RESTDESCRIPTION -Removes a graph from the collection *\_graphs*. +Removes a graph from the collection *_graphs*. @RESTURLPARAMETERS diff --git a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md index 65f8e8e792..2281ed544b 100644 --- a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md +++ b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md @@ -6,7 +6,7 @@ @RESTDESCRIPTION Creates a new edge in the collection. -Within the body the has to contain a *\_from* and *\_to* value referencing to valid vertices in the graph. +Within the body the has to contain a *_from* and *_to* value referencing to valid vertices in the graph. Furthermore the edge has to be valid in the definition of this [edge collection](../../Manual/Appendix/Glossary.html#edge-collection). diff --git a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md index 28e3b2d4cc..3c9406de2c 100644 --- a/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md +++ b/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md @@ -5,7 +5,7 @@ @RESTHEADER{GET /_api/gharial/{graph-name}, Get a graph} @RESTDESCRIPTION -Gets a graph from the collection *\_graphs*. +Gets a graph from the collection *_graphs*. Returns the definition content of this graph. @RESTURLPARAMETERS