From 0ce2568028946e0356cd8c3f4b97e307ffeed275 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sun, 22 Jan 2023 18:26:38 +0100 Subject: [PATCH] doc improvements --- src/ecss.rs | 3 +++ src/tc.rs | 4 ++-- src/tm.rs | 5 ++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/ecss.rs b/src/ecss.rs index 199b04b..b597476 100644 --- a/src/ecss.rs +++ b/src/ecss.rs @@ -1,5 +1,8 @@ //! Common definitions and helpers required to create PUS TMTC packets according to //! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/) +//! +//! You can find the PUS telecommand definitions in the [crate::tc] module and ithe PUS telemetry definitions +//! inside the [crate::tm] module. use crate::{ByteConversionError, CcsdsPacket, SizeMissmatch}; use core::fmt::{Debug, Display, Formatter}; use core::mem::size_of; diff --git a/src/tc.rs b/src/tc.rs index 844b449..d70aa9e 100644 --- a/src/tc.rs +++ b/src/tc.rs @@ -205,8 +205,8 @@ impl PusTcSecondaryHeader { } } -/// This class models a PUS telecommand. It is the primary data structure to generate the raw byte -/// representation of a PUS telecommand or to deserialize from one from raw bytes. +/// This class models the PUS C telecommand packet. It is the primary data structure to generate the +/// raw byte representation of a PUS telecommand or to deserialize from one from raw bytes. /// /// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the /// [serde] feature is used, which allows to send around TC packets in a raw byte format using a diff --git a/src/tm.rs b/src/tm.rs index 6a79188..8bcc932 100644 --- a/src/tm.rs +++ b/src/tm.rs @@ -189,9 +189,8 @@ impl<'slice> TryFrom> for PusTmSecondaryHeader<'slice } } -/// This class models a PUS telemetry and which can also be used. It is the primary data -/// structure to generate the raw byte representation of PUS telemetry or to -/// deserialize from one from raw bytes. +/// This class models the PUS C telemetry packet. It is the primary data structure to generate the +/// raw byte representation of PUS telemetry or to deserialize from one from raw bytes. /// /// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the [serde] /// feature is used which allows to send around TM packets in a raw byte format using a serde