From 285f1d4516353518bfb9f0813c382fb56f23f205 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Wed, 13 Aug 2025 14:19:48 -0300 Subject: [PATCH] Expand documentation for the groups module --- src/groups/mod.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/groups/mod.rs b/src/groups/mod.rs index d5398e3..e116d92 100644 --- a/src/groups/mod.rs +++ b/src/groups/mod.rs @@ -1,4 +1,18 @@ //! Payphone-specific code. All features like calls and moderation go here. +//! +//! Sub-modules in this module usually follow the same structure: +//! +//! - A `mod.rs` file exporting the public API of the sub-module. +//! - A `commands.rs` file containing the command definitions. +//! - A `embeds.rs` file containing embed-generating functions for those commands. +//! - A `events.rs` file containing event handlers related to the features the sub-module covers. +//! - Any additional modules the sub-module may specifically require. +//! +//! An example of extra modules not listed above is the [`calls::moderation`] module, which +//! includes the tools for parsing messages and detecting rule breakings in them. +//! +//! > *Note that not all sub-modules have commands, nor they all have event listeners, etc. Each of +//! > them only defines the modules they need.* pub mod about; pub mod calls;