From cb0510c0801317c4e9dffa1f83c2ff1a978178d1 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sun, 23 May 2021 16:59:26 -0700 Subject: docs(global): spelling corrections, global docs --- crates/README.rst | 2 +- crates/whirl_api/src/lib.rs | 2 ++ crates/whirl_common/Cargo.toml | 2 +- crates/whirl_common/src/lib.rs | 2 ++ crates/whirl_config/src/lib.rs | 2 ++ crates/whirl_db/src/lib.rs | 2 ++ crates/whirl_db/src/models.rs | 4 +++- crates/whirl_prompt/src/lib.rs | 2 ++ crates/whirl_server/src/lib.rs | 4 ++++ 9 files changed, 19 insertions(+), 3 deletions(-) diff --git a/crates/README.rst b/crates/README.rst index 0b0860b..a2e262c 100644 --- a/crates/README.rst +++ b/crates/README.rst @@ -15,7 +15,7 @@ - The API, for external interaction. - :code:`0.1.0` * - :code:`whirl_common` - - Assorted utilites, for global use. + - Assorted utilities, for global use. - :code:`0.1.0` * - :code:`whirl_config` - Configuration utilities, to interact with the configuration system. diff --git a/crates/whirl_api/src/lib.rs b/crates/whirl_api/src/lib.rs index 0b24953..3ab6cd8 100644 --- a/crates/whirl_api/src/lib.rs +++ b/crates/whirl_api/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! The API, for external interaction. + #![feature( type_ascription, hash_set_entry, diff --git a/crates/whirl_common/Cargo.toml b/crates/whirl_common/Cargo.toml index f6d973c..efc6047 100644 --- a/crates/whirl_common/Cargo.toml +++ b/crates/whirl_common/Cargo.toml @@ -3,7 +3,7 @@ name = "whirl_common" version = "0.1.0" authors = ["Fuwn "] edition = "2018" -description = "Assorted utilites, for global use." +description = "Assorted utilities, for global use." documentation = "https://whirlsplash.org/docs/" readme = "../../README.rst" homepage = "https://whirlsplash.org" diff --git a/crates/whirl_common/src/lib.rs b/crates/whirl_common/src/lib.rs index 05a0e0c..081da1c 100644 --- a/crates/whirl_common/src/lib.rs +++ b/crates/whirl_common/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! Assorted utilities, for global use. + #![feature( type_ascription, hash_set_entry, diff --git a/crates/whirl_config/src/lib.rs b/crates/whirl_config/src/lib.rs index 0a6d225..63fd5d0 100644 --- a/crates/whirl_config/src/lib.rs +++ b/crates/whirl_config/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! Configuration utilities, to interact with the configuration system. + #![feature( type_ascription, hash_set_entry, diff --git a/crates/whirl_db/src/lib.rs b/crates/whirl_db/src/lib.rs index 4f8050e..eda95bf 100644 --- a/crates/whirl_db/src/lib.rs +++ b/crates/whirl_db/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! Database utilities, to interact with the database. + #![feature( type_ascription, hash_set_entry, diff --git a/crates/whirl_db/src/models.rs b/crates/whirl_db/src/models.rs index 52304b6..b5913ef 100644 --- a/crates/whirl_db/src/models.rs +++ b/crates/whirl_db/src/models.rs @@ -2,7 +2,9 @@ // SPDX-License-Identifier: GPL-3.0-only //! Much of the documentation that you will see within this module is quoted -//! from http://dev.worlds.net/private/GammaDocs/WorldServer.html#RoomServer. +//! from +//! [this](http://dev.worlds.net/private/GammaDocs/WorldServer.html#RoomServer) +//! section from the Gamma Documents. // use crate::db::schema::*; diff --git a/crates/whirl_prompt/src/lib.rs b/crates/whirl_prompt/src/lib.rs index 0c4ded4..e33adce 100644 --- a/crates/whirl_prompt/src/lib.rs +++ b/crates/whirl_prompt/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! The Whirl Shell, for local interaction. + #![feature( type_ascription, hash_set_entry, diff --git a/crates/whirl_server/src/lib.rs b/crates/whirl_server/src/lib.rs index 584b0b0..a5efc24 100644 --- a/crates/whirl_server/src/lib.rs +++ b/crates/whirl_server/src/lib.rs @@ -1,6 +1,8 @@ // Copyleft (ɔ) 2021-2021 The Whirlsplash Collective // SPDX-License-Identifier: GPL-3.0-only +//! Exposes the Distributor and Hub for further use. + #![feature( type_ascription, hash_set_entry, @@ -34,6 +36,8 @@ use tokio::{ use crate::interaction::shared::Shared; +/// The type of server the `listen` method of the `Server` trait will +/// implemented for. #[derive(Debug)] pub enum ServerType { AnonRoomServer, -- cgit v1.2.3