minor docs update
Some checks failed
Rust/sat-rs/pipeline/pr-main There was a failure building this commit

This commit is contained in:
Robin Müller 2024-04-15 18:44:35 +02:00
parent ca6e4816ab
commit e20576f7ef
Signed by: muellerr
GPG Key ID: A649FB78196E3849

View File

@ -5,14 +5,14 @@ use crate::{tmtc::PacketSenderRaw, ComponentId};
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum SpacePacketValidation {
Valid,
/// The space packet header can be assumed to have a valid format, but the packet should
/// The space packet can be assumed to have a valid format, but the packet should
/// be ignored.
Ignore,
/// The space packet or space packet header has an invalid format, for example a CRC check
/// failed. In that case, the parser loses the packet synchronization and needs to check for
/// the start of a new space packet header start again. The space packet header
/// [spacepackets::PacketId] can be used as a synchronization marker to detect the validity
/// of a packet.
/// [spacepackets::PacketId] can be used as a synchronization marker to detect the start
/// of a possible valid packet again.
Invalid,
}