From 2d8e9b991ad9fe53d4c982fdd348dfef5a500d9e Mon Sep 17 00:00:00 2001 From: Maciej Myszkiewicz Date: Sun, 11 Oct 2026 19:55:04 +0200 Subject: [PATCH] chore: deny missing_docs again MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Removing it was a measurement, and the measurement said it was not where the comment volume came from: its floor is one summary line per public item, 793 lines, 3% of the workspace. The volume is in the paragraphs under those summaries, and those turned out to be API contract — what a frame length is measured between, that a UDP read never returns Ok(0), which lock is held across what — rather than prose that could go. So the lint costs nothing that was worth having and keeps the next public item from arriving without a sentence. Back. --- crates/xtce-gs-cli/src/main.rs | 1 + crates/xtce-gs-core/src/lib.rs | 1 + crates/xtce-gs-engine/src/lib.rs | 1 + crates/xtce-gs-gui/src/lib.rs | 1 + crates/xtce-gs-link/src/lib.rs | 1 + 5 files changed, 5 insertions(+) diff --git a/crates/xtce-gs-cli/src/main.rs b/crates/xtce-gs-cli/src/main.rs index a47d52d..a0165c7 100644 --- a/crates/xtce-gs-cli/src/main.rs +++ b/crates/xtce-gs-cli/src/main.rs @@ -4,6 +4,7 @@ //! Everything that decides anything is in [`args`] — which turns flags into an //! [`xtce_gs_engine::SessionConfig`] — or in [`run`], which carries one out. +#![deny(missing_docs)] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic)] #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)] diff --git a/crates/xtce-gs-core/src/lib.rs b/crates/xtce-gs-core/src/lib.rs index 8993e77..f7550c1 100644 --- a/crates/xtce-gs-core/src/lib.rs +++ b/crates/xtce-gs-core/src/lib.rs @@ -28,6 +28,7 @@ //! is one enum wide, and the table needs it — and only a watched parameter gets a ring. The //! interface decides what is watched when the operator opens a plot. +#![deny(missing_docs)] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic)] #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)] diff --git a/crates/xtce-gs-engine/src/lib.rs b/crates/xtce-gs-engine/src/lib.rs index da6dd4d..d3be93a 100644 --- a/crates/xtce-gs-engine/src/lib.rs +++ b/crates/xtce-gs-engine/src/lib.rs @@ -34,6 +34,7 @@ //! every real downlink has them. A recording is bytes and nothing else, so that it replays //! through the same source that wrote it. +#![deny(missing_docs)] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic)] #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)] diff --git a/crates/xtce-gs-gui/src/lib.rs b/crates/xtce-gs-gui/src/lib.rs index baf441f..343f5ad 100644 --- a/crates/xtce-gs-gui/src/lib.rs +++ b/crates/xtce-gs-gui/src/lib.rs @@ -30,6 +30,7 @@ //! not pop up, sound, or acknowledge. A station that interrupted the operator would be a //! station they mute. +#![deny(missing_docs)] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic)] #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)] diff --git a/crates/xtce-gs-link/src/lib.rs b/crates/xtce-gs-link/src/lib.rs index 4fb43f9..ba327f8 100644 --- a/crates/xtce-gs-link/src/lib.rs +++ b/crates/xtce-gs-link/src/lib.rs @@ -40,6 +40,7 @@ //! * **It does not panic.** It sits on a live downlink fed by hardware nobody here controls, //! so every failure is a `Result` or a counter. +#![deny(missing_docs)] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic)] #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)]