some more docs

This commit is contained in:
Robin Müller 2022-09-06 10:47:10 +02:00
parent fc77300ee2
commit ac56fbae99
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
2 changed files with 3 additions and 3 deletions

View File

@ -2,6 +2,6 @@
//!
//! Currenty includes:
//!
//! 1. PUS Verification Service 1 module inside [verification]
//! 1. PUS Verification Service 1 module inside [verification]. Requires [alloc] support.
#[cfg(feature = "alloc")]
pub mod verification;

View File

@ -3,10 +3,10 @@
//! This module allows packaging and sending PUS Service 1 packets. It is conforming to section
//! 8 of the PUS standard ECSS-E-ST-70-41C.
//!
//! The core object to report TC verification progress is the [VerifictionReporter]. It exposes
//! The core object to report TC verification progress is the [VerificationReporter]. It exposes
//! an API which uses type-state programming to avoid calling the verification steps in
//! an invalid order.
//!
//!
//! # Example
//! TODO: Cross Ref integration test which will be provided
use crate::pool::{LocalPool, StoreAddr, StoreError};