doc improvements
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good

This commit is contained in:
Robin Müller 2023-01-22 18:26:38 +01:00
parent b55fe9f443
commit 0ce2568028
No known key found for this signature in database
GPG Key ID: BE6480244DFE612C
3 changed files with 7 additions and 5 deletions

View File

@ -1,5 +1,8 @@
//! Common definitions and helpers required to create PUS TMTC packets according to //! 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/) //! [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 crate::{ByteConversionError, CcsdsPacket, SizeMissmatch};
use core::fmt::{Debug, Display, Formatter}; use core::fmt::{Debug, Display, Formatter};
use core::mem::size_of; use core::mem::size_of;

View File

@ -205,8 +205,8 @@ impl PusTcSecondaryHeader {
} }
} }
/// This class models a PUS telecommand. It is the primary data structure to generate the raw byte /// This class models the PUS C telecommand packet. It is the primary data structure to generate the
/// representation of a PUS telecommand or to deserialize from one from raw bytes. /// 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 /// 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 /// [serde] feature is used, which allows to send around TC packets in a raw byte format using a

View File

@ -189,9 +189,8 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
} }
} }
/// This class models a PUS telemetry and which can also be used. It is the primary data /// This class models the PUS C telemetry packet. It is the primary data structure to generate the
/// structure to generate the raw byte representation of PUS telemetry or to /// raw byte representation of PUS telemetry or to deserialize from one from raw bytes.
/// deserialize from one from raw bytes.
/// ///
/// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the [serde] /// 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 /// feature is used which allows to send around TM packets in a raw byte format using a serde