Skip to content

Commit

Permalink
Add missing doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
romac committed May 16, 2024
1 parent c2e0eed commit da538c0
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 1 deletion.
2 changes: 2 additions & 0 deletions src/de.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Helpers for annotating types to deserialize from ITF values.

use serde::de::DeserializeOwned;

use crate::Value;
Expand Down
1 change: 1 addition & 0 deletions src/de/error.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use std::fmt;

/// Error type for deserialization.
#[derive(Debug)]
pub enum Error {
Custom(String),
Expand Down
1 change: 0 additions & 1 deletion src/de/helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::<_>>")]
Expand Down
2 changes: 2 additions & 0 deletions src/error.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Error type for the library.

/// Error type for the library.
#[derive(Debug)]
pub enum Error {
Expand Down
2 changes: 2 additions & 0 deletions src/runner.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Infrastructure for running a trace against a concrete implementation.

use crate::Trace;

pub trait Runner {
Expand Down
2 changes: 2 additions & 0 deletions src/state.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Defines the states contained within an ITF trace.

use std::collections::BTreeMap;

use serde::de::DeserializeOwned;
Expand Down
2 changes: 2 additions & 0 deletions src/trace.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Defines an ITF trace.

use std::collections::BTreeMap;

use serde::de::DeserializeOwned;
Expand Down

0 comments on commit da538c0

Please sign in to comment.