Document the annotation struct for the protocol (#7828)

Add it to the documentation for every message type that uses it.
geldata · Oct 4, 2024 · 02e579f · 02e579f
1 parent b402d16
commit 02e579f
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/reference/protocol/messages.rst b/docs/reference/protocol/messages.rst
@@ -182,6 +182,8 @@ Format:
 
 .. eql:struct:: edb.protocol.TransactionState
 
+.. eql:struct:: edb.protocol.Annotation
+
 .. _ref_protocol_msg_restore_ready:
 
 RestoreReady
@@ -196,6 +198,8 @@ Format:
 
 .. eql:struct:: edb.protocol.RestoreReady
 
+.. eql:struct:: edb.protocol.Annotation
+
 .. _ref_protocol_msg_command_complete:
 
 CommandComplete
@@ -207,6 +211,8 @@ Format:
 
 .. eql:struct:: edb.protocol.CommandComplete
 
+.. eql:struct:: edb.protocol.Annotation
+
 
 .. _ref_protocol_msg_dump:
 
@@ -221,6 +227,8 @@ Format:
 
 .. eql:struct:: edb.protocol.Dump
 
+.. eql:struct:: edb.protocol.Annotation
+
 
 .. _ref_protocol_msg_command_data_description:
 
@@ -235,6 +243,8 @@ Format:
 
 .. eql:struct:: edb.protocol.enums.Cardinality
 
+.. eql:struct:: edb.protocol.Annotation
+
 
 The format of the *input_typedesc* and *output_typedesc* fields is described
 in the :ref:`ref_proto_typedesc` section.
@@ -325,6 +335,8 @@ Format:
 
 .. eql:struct:: edb.protocol.OutputFormat
 
+.. eql:struct:: edb.protocol.Annotation
+
 Use:
 
 * ``BINARY`` to return data encoded in binary.
@@ -357,6 +369,8 @@ Sent by: client.
 
 .. eql:struct:: edb.protocol.Capability
 
+.. eql:struct:: edb.protocol.Annotation
+
 See RFC1004_ for more information on capability flags.
 
 .. eql:struct:: edb.protocol.CompilationFlag