Skip to content

Add an example of a parameter within backticks #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2024
Merged

Add an example of a parameter within backticks #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ All Neo4j status codes follow the syntax `Neo.[Type].[SubType].[Name]`.

The notification title and the error description contain similar information.
Therefore, they follow the same guidelines.
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).
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`).
Avoid explaining the cause, consequences, or solution.
The notification title and description will be replaced by a single field `message` in 6.0.
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.
Expand Down Expand Up @@ -275,7 +275,7 @@ The message should follow the same guidelines as the notification description, n
The message should contain the most important information for the user.
It should be brief, scannable, specific, and contain the following details (if applicable):

* 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).
* 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`).
* Cause -- what triggered the code to be returned.
* A simple solution if possible.

Expand Down