Skip to content

Commit 011ec68

Browse files
Standardise admonitions (#1382)
Most admonitions are either [NOTE], [TIP], [IMPORTANT]. This tries to standardise their use, using the following guidelines: [NOTE]: Use for general information or observations that are helpful but not critical. [TIP]: Use for optional advice, shortcuts, or suggestions that enhance understanding or efficiency. [IMPORTANT]: Use for essential information that the reader must follow to avoid mistakes or problems.
1 parent 835f1c0 commit 011ec68

File tree

23 files changed

+35
-65
lines changed

23 files changed

+35
-65
lines changed

modules/ROOT/pages/clauses/clause-composition.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,8 @@ The next section will explore these non-linear composition and write clauses.
128128
In a Cypher query, read and write clauses can take turns.
129129
The most important aspect of read-write queries is that the state of the graph also changes between clauses.
130130

131-
[IMPORTANT]
132-
====
131+
[NOTE]
133132
A clause can never observe writes made by a later clause, and will observe all writes done by the previous clauses.
134-
====
135133

136134
As of Cypher 25, read and write clauses can be combined in any order.
137135
That is, a write clause followed by a read clause no longer requires a separating xref:clauses/with.adoc[`WITH`] clause in order for the read clause to observe the changes made by a preceding write clause.

modules/ROOT/pages/clauses/foreach.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ This means that if you `CREATE` a node variable within a `FOREACH`, you will _no
1212
Within the `FOREACH` parentheses, you can do any of the updating commands -- `SET`, `REMOVE`, `CREATE`, `MERGE`, `DELETE`, and `FOREACH`.
1313

1414
[TIP]
15-
====
1615
If you want to execute an additional `MATCH` for each element in a list then the xref::clauses/unwind.adoc[`UNWIND`] clause would be a more appropriate command.
17-
====
1816

1917
image::graph-foreach-clause.svg[Person nodes connected between themselves via knows relationships,width=600,role=popup]
2018

modules/ROOT/pages/clauses/load-csv.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,7 @@ RETURN DISTINCT file() AS path
808808
|===
809809
====
810810

811-
[TIP]
811+
[NOTE]
812812
`file()` always returns a local path, even when loading remote CSV files.
813813
For remote resources, `file()` returns the temporary local path it was downloaded to.
814814

modules/ROOT/pages/clauses/optional-match.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ The `WHERE` clause is part of the pattern description, and its predicates will b
1414
This matters especially in the case of multiple (`OPTIONAL`) `MATCH` clauses, where it is crucial to put `WHERE` together with the `MATCH` it belongs to.
1515

1616

17-
[TIP]
18-
====
19-
To understand the patterns used in the `OPTIONAL MATCH` clause, read xref::patterns/index.adoc[Patterns].
20-
====
21-
2217
== Example graph
2318

2419
The following graph is used for the examples below:

modules/ROOT/pages/clauses/order-by.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It can also be used as a standalone clause, either on its own or in combination
1010
`ORDER BY` relies on comparisons to sort the output (see xref:values-and-types/ordering-equality-comparison.adoc[] for more details).
1111
You can sort on different values, such as node or relationship properties, IDs, or the result of expressions.
1212

13-
[IMPORTANT]
13+
[NOTE]
1414
Unless `ORDER BY` is used, Neo4j does not guarantee the row order of a query result.
1515

1616

modules/ROOT/pages/clauses/remove.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,12 @@
44
= REMOVE
55

66
The `REMOVE` clause is used to remove properties from nodes and relationships, and to remove labels from nodes.
7-
8-
[TIP]
9-
====
10-
For deleting nodes and relationships, see xref::clauses/delete.adoc[`DELETE`].
11-
====
7+
To delete nodes and relationships, use the xref::clauses/delete.adoc[`DELETE`] clause.
128

139
[NOTE]
14-
====
1510
Removing labels from a node is an idempotent operation: if you try to remove a label from a node that does not have that label on it, nothing happens.
1611
The query statistics will tell you if something needed to be done or not.
17-
====
12+
1813

1914
== Example graph
2015

modules/ROOT/pages/clauses/return.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,7 @@ d|Rows: 1
9595
|===
9696

9797
[TIP]
98-
====
99-
To only return the value of a property, do not not return the full node/relationship.
100-
This will improve performance.
101-
====
98+
It is more performant to return properties rather than the full node or relationship.
10299

103100

104101
[[return-all-elements]]

modules/ROOT/pages/clauses/with.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `WITH` clause serves multiple purposes in Cypher:
1313
* xref:clauses/with.adoc#ordering-pagination[Order and paginate results]
1414
* xref:clauses/with.adoc#filter-results[Filter results]
1515

16-
[IMPORTANT]
16+
[NOTE]
1717
As of Cypher 25, `WITH` is no longer required as a separator between a write and a read clause.
1818

1919
[[example-graph]]

modules/ROOT/pages/expressions/predicates/comparison-operators.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Cypher contains the following comparison operators:
1414
* `IS NULL`
1515
* `IS NOT NULL`
1616
17-
[TIP]
17+
[NOTE]
1818
For more information about how Cypher orders and compares different value types, see xref:values-and-types/ordering-equality-comparison.adoc[Values and types -> Equality, ordering, and comparison of value types]
1919

2020

modules/ROOT/pages/functions/aggregating.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ An aggregating function performs a calculation over a set of values, returning a
99
Aggregation can be computed over all the matching paths, or it can be further divided by introducing xref:functions/aggregating.adoc#grouping-keys[grouping keys].
1010

1111
[TIP]
12-
====
13-
To learn more about how Cypher handles aggregations performed on zero rows, refer to link:https://neo4j.com/developer/kb/understanding-aggregations-on-zero-rows/[Neo4j Knowledge Base -> Understanding aggregations on zero rows].
14-
====
12+
To learn more about how Cypher handles aggregations performed on zero rows, visit link:https://neo4j.com/developer/kb/understanding-aggregations-on-zero-rows/[Neo4j Knowledge Base -> Understanding aggregations on zero rows].
13+
1514

1615
== Example graph
1716

@@ -182,10 +181,9 @@ All the values are collected and returned in a single list:
182181
|===
183182

184183
[TIP]
185-
====
186184
Neo4j maintains a transactional count store for holding count metadata, which can significantly increase the speed of queries using the `count()` function.
187185
For more information about the count store, refer to link:https://neo4j.com/developer/kb/fast-counts-using-the-count-store/[Neo4j Knowledge Base -> Fast counts using the count store].
188-
====
186+
189187

190188
=== Using `count(*)` to return the number of nodes
191189

0 commit comments

Comments
 (0)