update class and subclass (#83) (#87)

Co-authored-by: Louise Söderström <[email protected]>

Author: renetapopova

README.adoc

@@ -27,7 +27,7 @@ npm run start
 ----
 
 This will build a set of HTML files in `build/site` and then serve them through an express server at http://localhost:8000.
-The start script will also listen for changes and automatically rebuild the files automatically.
+The start script will also listen for changes and automatically rebuild the files.
 You will still need to refresh the page to view the changes.
 
 [[contributing]]
@@ -76,7 +76,7 @@ Each error and notification comprises the following components, some of which ar
 | Notification
 | Error
 
-| StatusCode (`Neo.[Class].[Subclass].[Name]`)
+| StatusCode (`Neo.[Type].[SubType].[Name]`)
 | See <<statuscode-syntax, StatusCode syntax>>.
 | For example, `Neo.ClientNotification.Statement.CartesianProduct`.
 | For example, `Neo.DatabaseError.Statement.RemoteExecutionFailed`.
@@ -103,14 +103,14 @@ m| ERROR
 
 | Message (It will replace the notification title and description, and the error description and message in 6.0.)
 | See <<message, Message>>.
-2+| Contains the main information, such as the problem, cause, consequences, a simple solution, or a reference to the Status Codes documentation.
+2+| Contains the main information, such as the problem, cause, consequences, a simple solution if possible.
 
-| Example (only in Status Codes documentation)
+| Example (only in the Neo4j Status Codes documentation)
 | See <<example, Example>>.
 | Contains one or more example queries to illustrate the possible scenarios when this notification would be returned.
 | N/A for 5.x
 
-| Suggestions for improvement (only in Status Codes documentation)
+| Suggestions for improvement (only in the Neo4j Status Codes documentation)
 | See <<example, Example>>.
 | Contains a possible solution for the provided example query.
 | N/A for 5.x
@@ -121,14 +121,14 @@ The following are guidelines on how to write each of the notification and error
 [[statuscode-syntax]]
 ==== StatusCode syntax
 
-All Neo4j status codes follow the syntax `Neo.[Class].[Subclass].[Name]`.
+All Neo4j status codes follow the syntax `Neo.[Type].[SubType].[Name]`.
 
 [options="header",cols="h,1,2,3,3,2",]
 |===
 | StatusCode
 | `Neo`
-| `[Class]`
-| `[Subclass]`
+| `[Type]`
+| `[SubType]`
 | `[Name]`
 | Example
 
@@ -249,7 +249,7 @@ This component is currently documented only for notifications.
 If you are updating an error, you can skip this section.
 ====
 
-The examples and possible solutions are written only here in this repo, for the Status Codes doc.
+The examples and possible solutions are written only here in this repo, for the Neo4j Status Codes documentation.
 
 Add one or more example queries to illustrate the possible scenarios when this notification would be returned.
 They should look similar to the following:

modules/ROOT/pages/errors/all-errors.adoc

@@ -4,16 +4,16 @@
 [[neo4j-errors]]
 = List of all error codes
 
-This page contains lists of all Neo4j errors, grouped by class.
+This page contains lists of all Neo4j errors, grouped by type.
 
 == Client errors
 
-This is a complete list of all client error status codes Neo4j may return, and what they mean.
+This is a complete list of all client errors Neo4j may return, and what they mean.
 
 [options="header", cols="<1m,<1"]
 |===
 
-| Status Code
+| Neo4j status code
 | Description
 
 | Neo.ClientError.Cluster.NotALeader
@@ -271,12 +271,12 @@ You may want to retry with a longer timeout.
 
 == Transient errors
 
-This is a complete list of all transient error status codes Neo4j may return, and what they mean.
+This is a complete list of all transient errors Neo4j may return, and what they mean.
 
 [options="header", cols="<1m,<1"]
 |===
 
-| Status Code
+| Neo4j status code
 | Description
 
 | Neo.TransientError.Cluster.ReplicationFailure
@@ -375,91 +375,91 @@ Transaction may succeed if retried.
 
 == Database error
 
-This is a complete list of all database error status codes Neo4j may return, and what they mean.
+This is a complete list of all database errors Neo4j may return, and what they mean.
 
 [options="header", cols="<1m,<1"]
 |===
 
-| Status Code
-| Description 
+| Neo4j status code
+| Description
 
 | Neo.DatabaseError.Database.DatabaseLimitReached
-| The limit to number of databases has been reached. 
+| The limit to number of databases has been reached.
 
 | Neo.DatabaseError.Database.UnableToStartDatabase
-| Unable to start database. 
+| Unable to start database.
 
 | Neo.DatabaseError.Database.Unknown
 | Unknown database management error.
 
 | Neo.DatabaseError.Fabric.RemoteExecutionFailed
-| The database was unable to execute a remote part of the statement. 
+| The database was unable to execute a remote part of the statement.
 
 | Neo.DatabaseError.General.IndexCorruptionDetected
 |
 The request (directly or indirectly) referred to an index that is in a failed state.
-The index needs to be dropped and recreated manually. 
+The index needs to be dropped and recreated manually.
 
 | Neo.DatabaseError.General.SchemaCorruptionDetected
 |
 A malformed schema rule was encountered.
-Please contact your support representative. 
+Please contact your support representative.
 
 | Neo.DatabaseError.General.StorageDamageDetected
 |
 Expected set of files not found on disk.
-Please restore from backup. 
+Please restore from backup.
 
 | Neo.DatabaseError.General.UnknownError
-| An unknown error occurred. 
+| An unknown error occurred.
 
 | Neo.DatabaseError.Schema.ConstraintCreationFailed
-| Creating a requested constraint failed. 
+| Creating a requested constraint failed.
 
 | Neo.DatabaseError.Schema.ConstraintDropFailed
-| The database failed to drop a requested constraint. 
+| The database failed to drop a requested constraint.
 
 | Neo.DatabaseError.Schema.IndexCreationFailed
-| Failed to create an index. 
+| Failed to create an index.
 
 | Neo.DatabaseError.Schema.IndexDropFailed
-| The database failed to drop a requested index. 
+| The database failed to drop a requested index.
 
 | Neo.DatabaseError.Schema.LabelAccessFailed
-| The request accessed a label that did not exist. 
+| The request accessed a label that did not exist.
 
 | Neo.DatabaseError.Schema.PropertyKeyAccessFailed
-| The request accessed a property that does not exist. 
+| The request accessed a property that does not exist.
 
 | Neo.DatabaseError.Schema.RelationshipTypeAccessFailed
-| The request accessed a relationship type that does not exist. 
+| The request accessed a relationship type that does not exist.
 
 | Neo.DatabaseError.Schema.SchemaRuleAccessFailed
-| The request referred to a schema rule that does not exist. 
+| The request referred to a schema rule that does not exist.
 
 | Neo.DatabaseError.Schema.SchemaRuleDuplicateFound
-| The request referred to a schema rule that is defined multiple times. 
+| The request referred to a schema rule that is defined multiple times.
 
 | Neo.DatabaseError.Schema.TokenLimitReached
 | The maximum number of tokens of this type has been reached, no more tokens of this type can be created.
 
 | Neo.DatabaseError.Statement.ExecutionFailed
-| The database was unable to execute the statement. 
+| The database was unable to execute the statement.
 
 | Neo.DatabaseError.Statement.RemoteExecutionFailed
-| The database was unable to execute a remote part of the statement. 
+| The database was unable to execute a remote part of the statement.
 
 | Neo.DatabaseError.Transaction.LinkedTransactionError
-| The transaction was terminated because another transaction executing the same query encountered an error. 
+| The transaction was terminated because another transaction executing the same query encountered an error.
 
 | Neo.DatabaseError.Transaction.TransactionCommitFailed
-| The database was unable to commit the transaction. 
+| The database was unable to commit the transaction.
 
 | Neo.DatabaseError.Transaction.TransactionLogError
-| The database was unable to write transaction to log. 
+| The database was unable to write transaction to log.
 
 | Neo.DatabaseError.Transaction.TransactionRollbackFailed
-| The database was unable to roll back the transaction. 
+| The database was unable to roll back the transaction.
 
 | Neo.DatabaseError.Transaction.TransactionStartFailed
 | The database was unable to start the transaction.

modules/ROOT/pages/errors/index.adoc

@@ -3,15 +3,16 @@
 [[notifications]]
 = Error codes
 
-Error codes are returned by the server when the execution of a query fails.
-They all have severity level `ERROR` and are grouped into one of the following classes:
+Error codes are Neo4j status codes returned by the server when the execution of a query fails.
+They always have the severity level `ERROR`.
+Errors are grouped based on the type of the error code:
 
 Client errors::
     These errors are caused by the client and are usually related to the request itself.
     Client errors have the prefix `Neo.ClientError`.
 
 Transient errors::
-    These errors are detected by the server and are usually related to some kind of database unavailability, such as limits reached, out-of-memory, timeouts, etc. 
+    These errors are detected by the server and are usually related to some kind of database unavailability, such as limits reached, out-of-memory, timeouts, etc.
     The error can be temporary and could therefore succeed if retrying the request.
     Transient errors have the prefix `Neo.TransientError`.
 

modules/ROOT/pages/index.adoc

@@ -7,38 +7,38 @@ This document details all status codes that a Neo4j DBMS may return to indicate
 
 == Format
 
-Each status code follows the same format:
+Each Neo4j status code follows the same format:
 
 [source, status code format, role="noheader"]
 -----
-Neo.[Class].[Subclass].[Name]
+Neo.[Type].[SubType].[Name]
 -----
 
-== Classification
+== Types of Neo4j status codes
 
-The fact that a status code is returned by the server does not always mean there is a fatal error.
-Status codes can also indicate transient problems that may go away if you retry the request.
-The classification of the status code determines the effect on the transaction.
+The fact that a Neo4j status code is returned by the server does not always mean there is a fatal error.
+Neo4j status codes can also indicate transient problems that may go away if you retry the request.
+The type of the status code determines the effect on the transaction.
 
-.Neo4j status code classification
+.Neo4j status code types
 [options="header", cols="<1m,<2,<1"]
 |===
 
-| Class
+| Type
 | Description
-| Effect on the transaction 
+| Effect on the transaction
 
 | xref:errors/all-errors.adoc#_client_errors[ClientError]
 | The Client sent a bad request - changing the request might yield a successful outcome.
 | Rollback
 
 | xref:errors/all-errors#_transient_errors[TransientError]
 | The database cannot service the request right now, retrying later might yield a successful outcome.
-| Rollback 
+| Rollback
 
 | xref:errors/all-errors#_database_error[DatabaseError]
 | The database failed to service the request.
-| Rollback 
+| Rollback
 
 | xref:notifications/index.adoc[ClientNotifications]
 | The query execution was successful, but there are notifications about the request sent by the client.

modules/ROOT/pages/notifications/index.adoc

@@ -3,16 +3,16 @@
 [[notifications]]
 = Notification codes
 
-`ClientNotification` codes are messages returned by the server with severity `WARNING` or `INFORMATION`.
-Contrary to error messages, notifications are only returned if the execution of the query is successful.
+Notification codes are Neo4j status codes of type `ClientNotification`and are returned by the server with severity `WARNING` or `INFORMATION`.
+Contrary to errors, notifications are only returned if the execution of the query is successful.
 
 [[notification-format]]
-== Notification code fields
+== Notification object fields
 
 The notification object, which is part of the result summary, consists of the following fields:
 
-* *Code* -- The status code in the form of `Neo.ClientNotification.[Subclass].[Name]`.
-* *Title* -- The description of the status code.
+* *Code* -- The Neo4j status code in the form of `Neo.ClientNotification.[SubType].[Name]`.
+* *Title* -- The description of the Neo4j status code.
 * *Description* -- The description of a specific notification, which can contain details about the query being executed.
 * *Severity* -- The severity can be one of the following: +
   ** `WARNING`: There might be a problem with your query. Please, take a look. +