Skip to content

Commit 14138bb

Browse files
authored
Add an example of a parameter within backticks (neo4j#122) (neo4j#123)
Cherry-picked from neo4j#122
1 parent 6db98c7 commit 14138bb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ All Neo4j status codes follow the syntax `Neo.[Type].[SubType].[Name]`.
152152

153153
The notification title and the error description contain similar information.
154154
Therefore, they follow the same guidelines.
155-
Both should be brief (one short sentence), specific, and inform on the current situation and what code of the query triggered the notification/error (add it within backticks to show that it’s a code snippet).
155+
Both should be brief (one short sentence), specific, and inform on the current situation and what code of the query triggered the notification/error (add it within backticks to show that it’s a code snippet, e.g. \`dbname`).
156156
Avoid explaining the cause, consequences, or solution.
157157
The notification title and description will be replaced by a single field `message` in 6.0.
158158
The error description in 5.x is used just as a fallback error message in some specific cases, and in 6.0, it will no longer be used.
@@ -237,7 +237,7 @@ The message should follow the same guidelines as the notification description, n
237237
The message should contain the most important information for the user.
238238
It should be brief, scannable, specific, and contain the following details (if applicable):
239239

240-
* Problem -- what happened and what code of the query triggered the notification/error (add it within backticks to show that it’s a code snippet).
240+
* Problem -- what happened and what code of the query triggered the notification/error (add it within backticks to show that it’s a code snippet, e.g. \`dbname`).
241241
* Cause -- what triggered the code to be returned.
242242
* A simple solution if possible.
243243

0 commit comments

Comments
 (0)