From da538c0aaf214c6b56769d6847038ccb5eb1459e Mon Sep 17 00:00:00 2001
From: Romain Ruetschi <romain@informal.systems>
Date: Thu, 16 May 2024 09:07:41 +0200
Subject: [PATCH] Add missing doc comments

---
 src/de.rs         | 2 ++
 src/de/error.rs   | 1 +
 src/de/helpers.rs | 1 -
 src/error.rs      | 2 ++
 src/runner.rs     | 2 ++
 src/state.rs      | 2 ++
 src/trace.rs      | 2 ++
 7 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/de.rs b/src/de.rs
index ab5497e..e36ceab 100644
--- a/src/de.rs
+++ b/src/de.rs
@@ -1,3 +1,5 @@
+//! Helpers for annotating types to deserialize from ITF values.
+
 use serde::de::DeserializeOwned;
 
 use crate::Value;
diff --git a/src/de/error.rs b/src/de/error.rs
index 0f4dd49..6f7996b 100644
--- a/src/de/error.rs
+++ b/src/de/error.rs
@@ -1,5 +1,6 @@
 use std::fmt;
 
+/// Error type for deserialization.
 #[derive(Debug)]
 pub enum Error {
     Custom(String),
diff --git a/src/de/helpers.rs b/src/de/helpers.rs
index 37cc5fc..74c2d33 100644
--- a/src/de/helpers.rs
+++ b/src/de/helpers.rs
@@ -85,7 +85,6 @@ pub type Integer = serde_with::TryFromInto<BigInt>;
 ///
 /// use itf::de::{self, As};
 ///
-///
 /// #[derive(Debug, PartialEq, Deserialize)]
 /// struct FooOption {
 ///     #[serde(with = "As::<de::Option::<_>>")]
diff --git a/src/error.rs b/src/error.rs
index ae98ebb..c82189d 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -1,3 +1,5 @@
+//! Error type for the library.
+
 /// Error type for the library.
 #[derive(Debug)]
 pub enum Error {
diff --git a/src/runner.rs b/src/runner.rs
index ea35711..409523b 100644
--- a/src/runner.rs
+++ b/src/runner.rs
@@ -1,3 +1,5 @@
+//! Infrastructure for running a trace against a concrete implementation.
+
 use crate::Trace;
 
 pub trait Runner {
diff --git a/src/state.rs b/src/state.rs
index aa9d644..106e063 100644
--- a/src/state.rs
+++ b/src/state.rs
@@ -1,3 +1,5 @@
+//! Defines the states contained within an ITF trace.
+
 use std::collections::BTreeMap;
 
 use serde::de::DeserializeOwned;
diff --git a/src/trace.rs b/src/trace.rs
index caf63f7..c33aaa0 100644
--- a/src/trace.rs
+++ b/src/trace.rs
@@ -1,3 +1,5 @@
+//! Defines an ITF trace.
+
 use std::collections::BTreeMap;
 
 use serde::de::DeserializeOwned;