From 5bd9cbd3eea61721dd9e8ad80dea501beac493ed Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sun, 10 Aug 2025 21:55:21 -0300 Subject: [PATCH] Add constants.rs docs and update CLI's doc header --- src/cli.rs | 2 +- src/constants.rs | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/cli.rs b/src/cli.rs index a86d68c..8f605b6 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -1,4 +1,4 @@ -//! Payphone's main entry point, which initializes the bot and starts the event loop. +//! Payphone's main entry point. //! //! This module is responsible for parsing command line arguments, nothing else. //! diff --git a/src/constants.rs b/src/constants.rs index 5ff69f5..2e7035f 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -1,4 +1,10 @@ +//! Constants used throughout the Payphone project. + +/// The default command prefix used by the bot for new servers. pub const DEFAULT_PREFIX: &str = "p."; +/// A cream white color extracted from Payphone's avatar picture, used for generic embeds. pub const COLOR_WHITE: u32 = 0xE2D9D0; + +/// A red color used for error messages and moderator embeds. pub const COLOR_RED: u32 = 0xFF8787;