Skip to content

Commit 5f8affb

Browse files
authored
Formatting: Wrap references to AQL functions in backticks (#519)
1 parent 7858907 commit 5f8affb

File tree

48 files changed

+230
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+230
-244
lines changed

site/content/3.12/aql/common-errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ of an AQL query string.
1717

1818
## String concatenation
1919

20-
In AQL, strings must be concatenated using the [CONCAT()](functions/string.md#concat)
20+
In AQL, strings must be concatenated using the [`CONCAT()`](functions/string.md#concat)
2121
function. Joining them together with the `+` operator is not supported. Especially
2222
as JavaScript programmer it is easy to walk into this trap:
2323

site/content/3.12/aql/examples-and-query-patterns/counting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ description: >-
88
## Amount of documents in a collection
99

1010
To return the count of documents that currently exist in a collection,
11-
you can call the [LENGTH() function](../functions/array.md#length):
11+
you can call the [`LENGTH()` function](../functions/array.md#length):
1212

1313
```aql
1414
RETURN LENGTH(collection)
1515
```
1616

1717
This type of call is optimized since 2.8 (no unnecessary intermediate result
1818
is built up in memory) and it is therefore the preferred way to determine the count.
19-
Internally, [COLLECTION_COUNT()](../functions/miscellaneous.md#collection_count) is called.
19+
Internally, [`COLLECTION_COUNT()`](../functions/miscellaneous.md#collection_count) is called.
2020

2121
In earlier versions with `COLLECT ... WITH COUNT INTO` available (since 2.4),
22-
you may use the following code instead of *LENGTH()* for better performance:
22+
you may use the following code instead of `LENGTH()` for better performance:
2323

2424
```aql
2525
FOR doc IN collection

site/content/3.12/aql/examples-and-query-patterns/dynamic-attribute-names.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The results of the subquery are then made available to the main query and will
115115
be returned. But the attribute names in the result are still `name` and `value`,
116116
so we're not there yet.
117117

118-
So let us also employ AQL's [ZIP()](../functions/document-object.md#zip) function,
118+
So let us also employ AQL's [`ZIP()`](../functions/document-object.md#zip) function,
119119
which can create an object from two arrays:
120120

121121
- the first parameter to `ZIP()` is an array with the attribute names

site/content/3.12/aql/functions/arangosearch.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ enabled. The `PHRASE()` function will otherwise not find anything.
606606
#### Object tokens
607607

608608
- `{IN_RANGE: [low, high, includeLow, includeHigh]}`:
609-
see [IN_RANGE()](#in_range). *low* and *high* can only be strings.
609+
see [`IN_RANGE()`](#in_range). *low* and *high* can only be strings.
610610
- `{LEVENSHTEIN_MATCH: [token, maxDistance, transpositions, maxTerms, prefix]}`:
611611
- `token` (string): a string to search
612612
- `maxDistance` (number): maximum Levenshtein / Damerau-Levenshtein distance
@@ -621,14 +621,14 @@ enabled. The `PHRASE()` function will otherwise not find anything.
621621
remainders of the strings. This option can improve performance in cases where
622622
there is a known common prefix. The default value is an empty string
623623
(introduced in v3.7.13, v3.8.1).
624-
- `{STARTS_WITH: [prefix]}`: see [STARTS_WITH()](#starts_with).
624+
- `{STARTS_WITH: [prefix]}`: see [`STARTS_WITH()`](#starts_with).
625625
Array brackets are optional
626626
- `{TERM: [token]}`: equal to `token` but without Analyzer tokenization.
627627
Array brackets are optional
628628
- `{TERMS: [token1, ..., tokenN]}`: one of `token1, ..., tokenN` can be found
629629
in specified position. Inside an array the object syntax can be replaced with
630630
the object field value, e.g., `[..., [token1, ..., tokenN], ...]`.
631-
- `{WILDCARD: [token]}`: see [LIKE()](#like).
631+
- `{WILDCARD: [token]}`: see [`LIKE()`](#like).
632632
Array brackets are optional
633633

634634
An array token inside an array can be used in the `TERMS` case only.
@@ -906,7 +906,7 @@ Match documents with a [Damerau-Levenshtein distance](https://en.wikipedia.org/w
906906
lower than or equal to `distance` between the stored attribute value and
907907
`target`. It can optionally match documents using a pure Levenshtein distance.
908908

909-
See [LEVENSHTEIN_DISTANCE()](string.md#levenshtein_distance)
909+
See [`LEVENSHTEIN_DISTANCE()`](string.md#levenshtein_distance)
910910
if you want to calculate the edit distance of two strings.
911911

912912
- **path** (attribute path expression\|string): the path of the attribute to
@@ -1323,7 +1323,7 @@ _n_-grams for search highlighting purposes.
13231323
attributes:
13241324
- **name** (array): the attribute and array element path as an array of
13251325
strings and numbers. You can pass this name to the
1326-
[VALUE()](document-object.md) to dynamically look up the value.
1326+
[`VALUE()`](document-object.md) to dynamically look up the value.
13271327
- **offsets** (array): an array of arrays with the matched positions, capped
13281328
to the specified limits. Each inner array has two elements with the start
13291329
offset and the length of a match.

site/content/3.12/aql/functions/array.md

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Add all elements of an array to another array. All values are added at the end o
3434
array (right side).
3535

3636
It can also be used to append a single element to an array. It is not necessary to wrap
37-
it in an array (unless it is an array itself). You may also use [PUSH()](#push) instead.
37+
it in an array (unless it is an array itself). You may also use [`PUSH()`](#push) instead.
3838

3939
- **anyArray** (array): array with elements of arbitrary type
4040
- **values** (array\|any): array, whose elements shall be added to `anyArray`
@@ -211,9 +211,8 @@ FOR v, e, p IN 1..3 OUTBOUND 'places/Toronto' GRAPH 'kShortestPathsGraph'
211211
Return the intersection of all arrays specified. The result is an array of values that
212212
occur in all arguments.
213213

214-
Other set operations are [UNION()](#union),
215-
[MINUS()](#minus) and
216-
[OUTERSECTION()](#outersection).
214+
Other set operations are [`UNION()`](#union), [`MINUS()`](#minus) and
215+
[`OUTERSECTION()`](#outersection).
217216

218217
- **arrays** (array, *repeatable*): an arbitrary number of arrays as multiple arguments
219218
(at least 2)
@@ -320,7 +319,7 @@ Determine the number of elements in an array.
320319
- **anyArray** (array): array with elements of arbitrary type
321320
- returns **length** (number): the number of array elements in *anyArray*.
322321

323-
*LENGTH()* can also determine the [number of attribute keys](document-object.md#length)
322+
`LENGTH()` can also determine the [number of attribute keys](document-object.md#length)
324323
of an object / document, the [amount of documents](miscellaneous.md#length) in a
325324
collection and the [character length](string.md#length) of a string.
326325

@@ -382,9 +381,8 @@ RETURN LENGTH( {a:1, b:2, c:3, d:4, e:{f:5,g:6}} )
382381

383382
Return the difference of all arrays specified.
384383

385-
Other set operations are [UNION()](#union),
386-
[INTERSECTION()](#intersection) and
387-
[OUTERSECTION()](#outersection).
384+
Other set operations are [`UNION()`](#union), [`INTERSECTION()`](#intersection)
385+
and [`OUTERSECTION()`](#outersection).
388386

389387
- **arrays** (array, *repeatable*): an arbitrary number of arrays as multiple
390388
arguments (at least 2)
@@ -447,9 +445,8 @@ RETURN NTH( [ "foo", "bar", "baz" ], -1 )
447445

448446
Return the values that occur only once across all arrays specified.
449447

450-
Other set operations are [UNION()](#union),
451-
[MINUS()](#minus) and
452-
[INTERSECTION()](#intersection).
448+
Other set operations are [`UNION()`](#union), [`MINUS()`](#minus) and
449+
[`INTERSECTION()`](#intersection).
453450

454451
- **arrays** (array, *repeatable*): an arbitrary number of arrays as multiple arguments
455452
(at least 2)
@@ -472,9 +469,9 @@ RETURN OUTERSECTION( [ 1, 2, 3 ], [ 2, 3, 4 ], [ 3, 4, 5 ] )
472469

473470
Remove the last element of *array*.
474471

475-
To append an element (right side), see [PUSH()](#push).\
476-
To remove the first element, see [SHIFT()](#shift).\
477-
To remove an element at an arbitrary position, see [REMOVE_NTH()](#remove_nth).
472+
To append an element (right side), see [`PUSH()`](#push).\
473+
To remove the first element, see [`SHIFT()`](#shift).\
474+
To remove an element at an arbitrary position, see [`REMOVE_NTH()`](#remove_nth).
478475

479476
- **anyArray** (array): an array with elements of arbitrary type
480477
- returns **newArray** (array): *anyArray* without the last element. If it's already
@@ -517,7 +514,7 @@ the [`IN` operator](../operators.md#comparison-operators), for example,
517514
`3 IN [1, 2, 3]` instead of `POSITION([1, 2, 3], 3)`.
518515

519516
To determine if or at which position a string occurs in another string, see the
520-
[CONTAINS() string function](string.md#contains).
517+
[`CONTAINS()` string function](string.md#contains).
521518

522519
**Examples**
523520

@@ -566,9 +563,9 @@ existence, you may use the `IN` operator instead of calling `POSITION()`, like
566563

567564
Append *value* to *anyArray* (right side).
568565

569-
To remove the last element, see [POP()](#pop).\
570-
To prepend a value (left side), see [UNSHIFT()](#unshift).\
571-
To append multiple elements, see [APPEND()](#append).
566+
To remove the last element, see [`POP()`](#pop).\
567+
To prepend a value (left side), see [`UNSHIFT()`](#unshift).\
568+
To append multiple elements, see [`APPEND()`](#append).
572569

573570
- **anyArray** (array): array with elements of arbitrary type
574571
- **value** (any): an element of arbitrary type
@@ -579,7 +576,7 @@ To append multiple elements, see [APPEND()](#append).
579576

580577
Note: The *unique* flag only controls if *value* is added if it's already present
581578
in *anyArray*. Duplicate elements that already exist in *anyArray* will not be
582-
removed. To make an array unique, use the [UNIQUE()](#unique) function.
579+
removed. To make an array unique, use the [`UNIQUE()`](#unique) function.
583580

584581
**Examples**
585582

@@ -605,8 +602,8 @@ RETURN PUSH([ 1, 2, 2, 3 ], 2, true)
605602

606603
Remove the element at *position* from the *anyArray*.
607604

608-
To remove the first element, see [SHIFT()](#shift).\
609-
To remove the last element, see [POP()](#pop).
605+
To remove the first element, see [`SHIFT()`](#shift).\
606+
To remove the last element, see [`POP()`](#pop).
610607

611608
- **anyArray** (array): array with elements of arbitrary type
612609
- **position** (number): the position of the element to remove. Positions start
@@ -785,9 +782,9 @@ RETURN REVERSE ( [2,4,6,8,10] )
785782

786783
Remove the first element of *anyArray*.
787784

788-
To prepend an element (left side), see [UNSHIFT()](#unshift).\
789-
To remove the last element, see [POP()](#pop).\
790-
To remove an element at an arbitrary position, see [REMOVE_NTH()](#remove_nth).
785+
To prepend an element (left side), see [`UNSHIFT()`](#unshift).\
786+
To remove the last element, see [`POP()`](#pop).\
787+
To remove an element at an arbitrary position, see [`REMOVE_NTH()`](#remove_nth).
791788

792789
- **anyArray** (array): array with elements with arbitrary type
793790
- returns **newArray** (array): *anyArray* without the left-most element. If *anyArray*
@@ -923,9 +920,8 @@ RETURN SORTED_UNIQUE( [ 8,4,2,10,6,2,8,6,4 ] )
923920

924921
Return the union of all arrays specified.
925922

926-
Other set operations are [MINUS()](#minus),
927-
[INTERSECTION()](#intersection) and
928-
[OUTERSECTION()](#outersection).
923+
Other set operations are [`MINUS()`](#minus), [`INTERSECTION()`](#intersection)
924+
and [`OUTERSECTION()`](#outersection).
929925

930926
- **arrays** (array, *repeatable*): an arbitrary number of arrays as multiple
931927
arguments (at least 2)
@@ -946,9 +942,8 @@ RETURN UNION(
946942
```
947943

948944
Note: No duplicates will be removed. In order to remove duplicates, please use
949-
either [UNION_DISTINCT()](#union_distinct)
950-
or apply [UNIQUE()](#unique) on the
951-
result of *UNION()*:
945+
either [`UNION_DISTINCT()`](#union_distinct) or apply [`UNIQUE()`](#unique) on the
946+
result of `UNION()`:
952947

953948
```aql
954949
---
@@ -1013,8 +1008,8 @@ RETURN UNIQUE( [ 1,2,2,3,3,3,4,4,4,4,5,5,5,5,5 ] )
10131008

10141009
Prepend *value* to *anyArray* (left side).
10151010

1016-
To remove the first element, see [SHIFT()](#shift).\
1017-
To append a value (right side), see [PUSH()](#push).
1011+
To remove the first element, see [`SHIFT()`](#shift).\
1012+
To append a value (right side), see [`PUSH()`](#push).
10181013

10191014
- **anyArray** (array): array with elements of arbitrary type
10201015
- **value** (any): an element of arbitrary type
@@ -1025,7 +1020,7 @@ To append a value (right side), see [PUSH()](#push).
10251020

10261021
Note: The *unique* flag only controls if *value* is added if it's already present
10271022
in *anyArray*. Duplicate elements that already exist in *anyArray* will not be
1028-
removed. To make an array unique, use the [UNIQUE()](#unique) function.
1023+
removed. To make an array unique, use the [`UNIQUE()`](#unique) function.
10291024

10301025
**Examples**
10311026

site/content/3.12/aql/functions/bit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ BIT_DECONSTRUCT(2147484675) // [0, 1, 10, 31]
9898

9999
Converts a bitstring (consisting of digits `0` and `1`) into a number.
100100

101-
To convert a number into a bitstring, see [BIT_TO_STRING()](#bit_to_string).
101+
To convert a number into a bitstring, see [`BIT_TO_STRING()`](#bit_to_string).
102102

103103
- **bitstring** (string): string sequence consisting of `0` and `1` characters
104104
- returns **number** (number\|null): the parsed number
@@ -269,7 +269,7 @@ BIT_TEST(255, 8) // false
269269

270270
Converts a numeric input value into a bitstring, consisting of `0` and `1`.
271271

272-
To convert a bitstring into a number, see [BIT_FROM_STRING()](#bit_from_string).
272+
To convert a bitstring into a number, see [`BIT_FROM_STRING()`](#bit_from_string).
273273

274274
- **number** (number): the number to stringify
275275
- returns **bitstring** (string\|null): bitstring generated from the input value

site/content/3.12/aql/functions/date.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,7 +1076,7 @@ Add `amount` given in `unit` to `date` and return the calculated date.
10761076
- **date** (number\|string): numeric timestamp or ISO 8601 date time string
10771077
- **amount** (number\|string): number of `unit`s to add (positive value) or
10781078
subtract (negative value). It is recommended to use positive values only,
1079-
and use [DATE_SUBTRACT()](#date_subtract) for subtractions instead.
1079+
and use [`DATE_SUBTRACT()`](#date_subtract) for subtractions instead.
10801080
- **unit** (string): either of the following to specify the time unit to add or
10811081
subtract (case-insensitive):
10821082
- `"y"`, `"year"`, `"years"`
@@ -1161,15 +1161,15 @@ DATE_ADD("2000-01-01", "P1Y2M3W4DT5H6M7.89S") // add a bit of everything
11611161

11621162
Subtract `amount` given in `unit` from `date` and return the calculated date.
11631163

1164-
It works the same as [DATE_ADD()](#date_add), except that it subtracts. It is
1164+
It works the same as [`DATE_ADD()`](#date_add), except that it subtracts. It is
11651165
equivalent to calling `DATE_ADD()` with a negative amount, except that
11661166
`DATE_SUBTRACT()` can also subtract ISO durations. Note that negative ISO
11671167
durations are not supported (i.e. starting with `-P`, like `-P1Y`).
11681168

11691169
- **date** (number\|string): numeric timestamp or ISO 8601 date time string
11701170
- **amount** (number\|string): number of `unit`s to subtract (positive value) or
11711171
add (negative value). It is recommended to use positive values only,
1172-
and use [DATE_ADD()](#date_add) for additions instead.
1172+
and use [`DATE_ADD()`](#date_add) for additions instead.
11731173
- **unit** (string): either of the following to specify the time unit to add or
11741174
subtract (case-insensitive):
11751175
- `"y"`, `"year"`, `"years"`
@@ -1374,7 +1374,7 @@ with are "ignored". The query returns every document with `date` ranging from
13741374
`2015-05-15T00:00:00.000Z` to `2015-05-15T23:99:99.999Z`. It would also include
13751375
`2015-05-15T24:00:00.000Z`, but that date is actually `2015-05-16T00:00:00.000Z`
13761376
and can only occur if inserted manually (you may want to pass dates through
1377-
[DATE_ISO8601()](#date_iso8601) to ensure a correct date representation).
1377+
[`DATE_ISO8601()`](#date_iso8601) to ensure a correct date representation).
13781378

13791379
Leap days in leap years (29th of February) must be always handled manually,
13801380
if you require so (e.g. birthday checks):

site/content/3.12/aql/functions/document-object.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ RETURN [
187187
Keep only the attributes `attributeName` to `attributeNameN` of `document`.
188188
All other attributes will be removed from the result.
189189

190-
To do the opposite, see [UNSET()](#unset).
190+
To do the opposite, see [`UNSET()`](#unset).
191191

192192
- **document** (object): a document / object
193193
- **attributeNames** (string, *repeatable*): an arbitrary number of attribute
@@ -272,7 +272,7 @@ RETURN KEEP(doc, ["foo", "baz"])
272272
Recursively preserve the attributes `attributeName1` to `attributeNameN` from
273273
`document` and its sub-documents. All other attributes will be removed.
274274

275-
To do the opposite, use [UNSET_RECURSIVE()](#unset_recursive).
275+
To do the opposite, use [`UNSET_RECURSIVE()`](#unset_recursive).
276276

277277
- **document** (object): a document / object
278278
- **attributeNames** (string, *repeatable*): an arbitrary number of attribute
@@ -415,7 +415,7 @@ with any number of attributes each.
415415

416416
An attribute value of `null` will match documents with an explicit attribute value
417417
of `null` as well as documents with this attribute missing (implicitly `null`).
418-
Only [HAS()](#has) can differentiate between an attribute being absent and having
418+
Only [`HAS()`](#has) can differentiate between an attribute being absent and having
419419
a stored `null` value.
420420

421421
An empty object `{}` will match all documents. Be careful not to ask for all
@@ -485,7 +485,7 @@ If document attribute keys are ambiguous, the merged result will contain the val
485485
of the documents contained later in the argument list.
486486

487487
Note that merging will only be done for top-level attributes. If you wish to
488-
merge sub-attributes, use [MERGE_RECURSIVE()](#merge_recursive) instead.
488+
merge sub-attributes, use [`MERGE_RECURSIVE()`](#merge_recursive) instead.
489489

490490
- **documents** (object, *repeatable*): an arbitrary number of documents as
491491
multiple arguments (at least 2)
@@ -801,7 +801,7 @@ RETURN TRANSLATE(42, { "42": true } )
801801
Remove the attributes `attributeName1` to `attributeNameN` from `document`.
802802
All other attributes will be preserved.
803803

804-
To do the opposite, see [KEEP()](#keep).
804+
To do the opposite, see [`KEEP()`](#keep).
805805

806806
- **document** (object): a document / object
807807
- **attributeNames** (string, *repeatable*): an arbitrary number of attribute
@@ -887,7 +887,7 @@ RETURN UNSET(doc, ["foo", "bar"])
887887
Recursively remove the attributes `attributeName1` to `attributeNameN` from
888888
`document` and its sub-documents. All other attributes will be preserved.
889889

890-
To do the opposite, use [KEEP_RECURSIVE()](#keep_recursive).
890+
To do the opposite, use [`KEEP_RECURSIVE()`](#keep_recursive).
891891

892892
- **document** (object): a document / object
893893
- **attributeNames** (string, *repeatable*): an arbitrary number of attribute

site/content/3.12/aql/functions/fulltext.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ It is recommended to use [Inverted indexes](../../index-and-search/indexing/work
2121
Return all documents from collection *coll*, for which the attribute *attribute*
2222
matches the fulltext search phrase *query*, optionally capped to *limit* results.
2323

24-
**Note**: the *FULLTEXT()* function requires the collection *coll* to have a
24+
**Note**: the `FULLTEXT()` function requires the collection *coll* to have a
2525
fulltext index on *attribute*. If no fulltext index is available, this function
2626
will fail with an error at runtime. It doesn't fail when explaining the query however.
2727

@@ -32,7 +32,7 @@ will fail with an error at runtime. It doesn't fail when explaining the query ho
3232
to at most this number of documents
3333
- returns **docArray** (array): an array of documents
3434

35-
*FULLTEXT()* is not meant to be used as an argument to `FILTER`,
35+
`FULLTEXT()` is not meant to be used as an argument to `FILTER`,
3636
but rather to be used as the expression of a `FOR` statement:
3737

3838
```aql

site/content/3.12/aql/functions/geo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ RETURN GEO_POLYGON([
806806
`GEO_MULTIPOLYGON(polygons) → geoJson`
807807

808808
Construct a GeoJSON MultiPolygon. Needs at least two Polygons inside.
809-
See [GEO_POLYGON()](#geo_polygon) and [GeoJSON MultiPolygon](#multipolygon)
809+
See [`GEO_POLYGON()`](#geo_polygon) and [GeoJSON MultiPolygon](#multipolygon)
810810
for the rules of Polygon and MultiPolygon construction.
811811

812812
- **polygons** (array): an array of arrays of arrays of `[longitude, latitude]` pairs

0 commit comments

Comments
 (0)