ser: More docs

getty-zig · Nov 18, 2023 · 920258b · 920258b
1 parent 6bbb08b
commit 920258b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/ser/blocks/error.zig b/src/ser/blocks/error.zig
@@ -1,3 +1,5 @@
+//! `Error` is a _Serialization Block_ for error values.
+
 const std = @import("std");
 
 const getty_serialize = @import("../serialize.zig").serialize;

diff --git a/src/ser/error.zig b/src/ser/error.zig
@@ -1,5 +1,3 @@
-//! `Error` is a _Serialization Block_ for error values.
-
 /// A generic error set for `getty.Serializer` implementations.
 ///
 /// This error set must always be included in a `getty.Serializer`

diff --git a/src/ser/ser.zig b/src/ser/ser.zig
@@ -36,6 +36,10 @@ pub const getAttributes = @import("attributes.zig").getAttributes;
 // Error Sets
 ////////////////////////////////////////////////////////////////////////////////
 
+/// A generic error set for `getty.Serializer` implementations.
+///
+/// This error set must always be included in a `getty.Serializer`
+/// implementation's error set.
 pub const Error = @import("error.zig").Error;
 
 comptime {