docs

CQCL · Jan 17, 2025 · 7425257 · 7425257
1 parent c84c6ca
commit 7425257
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/hugr-model/src/v0/binary/read.rs b/hugr-model/src/v0/binary/read.rs
@@ -5,13 +5,13 @@ use crate::v0 as model;
 use bumpalo::collections::Vec as BumpVec;
 use bumpalo::Bump;
 
-/// TODO docs
+/// An error encounted while deserialising a model.
 #[derive(Debug, derive_more::From, derive_more::Display, derive_more::Error)]
 #[non_exhaustive]
 pub enum ReadError {
     #[from(forward)]
-    /// TODO docs
-    EncodingError(capnp::Error),
+    /// An error encounted while decoding a model from a `capnproto` buffer.
+    DecodingError(capnp::Error),
 }
 
 type ReadResult<T> = Result<T, ReadError>;

diff --git a/hugr-model/src/v0/binary/write.rs b/hugr-model/src/v0/binary/write.rs
@@ -3,11 +3,11 @@ use std::io::Write;
 use crate::hugr_v0_capnp as hugr_capnp;
 use crate::v0 as model;
 
-/// TODO docs
+/// An error encounter while serializing a model.
 #[derive(Debug, derive_more::From, derive_more::Display, derive_more::Error)]
 #[non_exhaustive]
 pub enum WriteError {
-    /// TODO docs
+    /// An error encountered while encoding a `capnproto` buffer.
     EncodingError(capnp::Error),
 }