From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 2 Apr 2022 11:55:11 +0000 (+0100)
Subject: Formulaic doc comments for other crates
X-Git-Tag: otter-1.0.0~9
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=b62472ed4e2afc3ab6335f70680b64b6458d4c86;p=otter.git

Formulaic doc comments for other crates

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/apitest/apitest.rs b/apitest/apitest.rs
index 5eec89ed..361a9945 100644
--- a/apitest/apitest.rs
+++ b/apitest/apitest.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 // ==================== namespace preparation ====================
 
 pub mod imports {
diff --git a/base/lib.rs b/base/lib.rs
index b65b228f..2366f15c 100644
--- a/base/lib.rs
+++ b/base/lib.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::redundant_closure_call)]
 #![allow(clippy::writeln_empty_string)]
 
diff --git a/jstest/jstest.rs b/jstest/jstest.rs
index b352cc15..a1d05335 100644
--- a/jstest/jstest.rs
+++ b/jstest/jstest.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::or_fun_call)]
 #![allow(clippy::unnecessary_operation)] // trips on #[throws(Explode)]
 
diff --git a/wasm/wasm.rs b/wasm/wasm.rs
index 251ec7cb..c7db365b 100644
--- a/wasm/wasm.rs
+++ b/wasm/wasm.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::unused_unit)] // #[wasm_bindgen] produces these?
 
 use otter_base::imports::*;
diff --git a/wdriver/wdriver.rs b/wdriver/wdriver.rs
index 35c43b0b..0b47d7d9 100644
--- a/wdriver/wdriver.rs
+++ b/wdriver/wdriver.rs
@@ -2,6 +2,12 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system (part thereeof)
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+
 #![allow(clippy::or_fun_call)]
 #![allow(clippy::unnecessary_operation)] // trips on #[throws(Explode)]
 #![allow(clippy::no_effect)] // trips on #[throws(Explode)]