You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ Each error and notification comprises the following components, some of which ar
87
87
| For example, `The database was unable to execute a remote part of the statement.`
88
88
89
89
| SeverityLevel
90
-
|
90
+
| See <<severity-level, Severity level>>.
91
91
| One of `INFORMATION`\|`WARNING`
92
92
m| ERROR
93
93
@@ -174,6 +174,27 @@ See <<message, Message>>.
174
174
| The label `Perso` does not exist.
175
175
|===
176
176
177
+
[[severity-level]]
178
+
==== Severity level
179
+
180
+
The severity can be one of the following:
181
+
182
+
* `WARNING`: It is about queries/commands that may have structural, syntactic, semantic, or spelling issues where the query most probably is wrong and/or should be updated.
183
+
This includes deprecations, experimental features, trying to match entities with non-existing labels, etc.
184
+
It should be clear what the problem is and it is also good to tell the possible cause, and the consequences, as well as give an example(s) and suggestion(s) for improvement.
185
+
The most important part is that "we are (almost) certain it is a problem" and we know how to fix their query.
186
+
For example:
187
+
188
+
** Deprecations – The users need to update the query with new functionality.
189
+
** Experimental features – These cannot be trusted and should be updated if used in production.
190
+
** Non-existing label – This query will never give any result, so it's either useless to run OR a misspelled label (unless they add a node with the label, but then the notification would disappear).
191
+
192
+
* `INFORMATION`: It is about queries/commands that are correct but may have some performance issues or that have no effect because they try to do something already done.
193
+
Depending on the case, we may give an example(s) and suggestion(s) for improvement.
194
+
195
+
* `ERROR`: It is about queries/commands that fail to succeed.
196
+
It's good to tell the user what triggers the error, an example, and a possible solution(s).
0 commit comments