docs: simplify comments

Author: DevYukine

src/abstraction/providers/mod.rs

@@ -36,7 +36,7 @@ pub struct ProviderPlatformInfo {
 	pub summary: Option<String>,
 }
 
-/// Slash-command choice parameter. Order here is what shows up in Discord's dropdown.
+/// Order here is the order shown in Discord's dropdown.
 #[derive(poise::ChoiceParameter, Clone, Copy, Debug)]
 pub enum ProviderChoice {
 	#[name = "IGDB"]
@@ -76,7 +76,7 @@ impl ProviderChoice {
 }
 
 /// Order in which the identification flow tries to enrich the card.
-/// `EmuReady` and `TheGamesDB` are intentionally excluded — they have no read endpoints.
+/// `EmuReady` and `TheGamesDB` are intentionally excluded. They have no read endpoints.
 pub const ENRICHMENT_PRIORITY: &[MetadataProvider] = &[
 	MetadataProvider::Igdb,
 	MetadataProvider::MobyGames,
@@ -87,7 +87,7 @@ pub const ENRICHMENT_PRIORITY: &[MetadataProvider] = &[
 	MetadataProvider::SteamGridDb,
 ];
 
-/// All providers, in the order rendered as columns in the list tables.
+/// Order here determines the column order in the `/list` tables.
 pub const ALL_PROVIDERS: &[MetadataProvider] = &[
 	MetadataProvider::Igdb,
 	MetadataProvider::MobyGames,

src/command/playmatch.rs

@@ -886,9 +886,8 @@ pub(crate) struct SuggestionMessageHandleData {
 	pub comment: Option<String>,
 }
 
-/// Posts the staff card (if `existing_message_id` is None) and then waits on the Approve/Decline
-/// buttons. Called inline from the suggest commands (with `None`) and from the external-suggestion
-/// poller (with `None` for new posts and `Some(id)` to re-attach to a pre-restart message).
+/// Posts the staff card and waits on the Approve/Decline buttons.
+/// Pass `Some(message_id)` to re-attach to an existing card instead of posting a new one.
 pub(crate) async fn handle_suggestion_message(
 	data: SuggestionMessageHandleData,
 	existing_message_id: Option<serenity::all::MessageId>,

src/events/suggestion_poller.rs

@@ -47,7 +47,6 @@ pub async fn run(ctx: Context, data: Arc<CommandData>) {
 	let channel_id = ChannelId::new(*SUGGESTION_CHANNEL_ID);
 	let seen: Arc<Mutex<HashSet<Uuid>>> = Arc::new(Mutex::new(HashSet::new()));
 
-	// Phase 1 + 2: scan channel history, build seen set, spawn recovery for each pending one.
 	match channel_id
 		.widen()
 		.messages(&http, GetMessages::new().limit(CHANNEL_SCAN_LIMIT))
@@ -73,9 +72,9 @@ pub async fn run(ctx: Context, data: Arc<CommandData>) {
 		}
 	}
 
-	// Phase 3: poll loop.
+	// The first tick fires immediately so we catch up on suggestions submitted while the
+	// bot was offline. Subsequent ticks wait the full interval.
 	let mut tick = interval(Duration::from_secs(*POLL_INTERVAL_SECS));
-	tick.tick().await; // consume immediate first tick
 	loop {
 		tick.tick().await;
 
@@ -173,7 +172,7 @@ fn spawn_recovery(
 			Ok(r) => r.into_inner(),
 			Err(e) => {
 				debug!(
-					"suggestion poller: recovery skipped — suggestion {suggestion_id} no longer pending: {e}"
+					"suggestion poller: recovery skipped, suggestion {suggestion_id} no longer pending: {e}"
 				);
 				return;
 			}

src/util/mod.rs

@@ -1,7 +1,6 @@
 extern crate unicode_width;
 use unicode_width::UnicodeWidthStr;
 
-// Function to pad a string to a specified width with spaces
 fn pad_string(input: &str, width: usize) -> String {
 	let length = UnicodeWidthStr::width(input);
 	if length >= width {
@@ -12,47 +11,39 @@ fn pad_string(input: &str, width: usize) -> String {
 	}
 }
 
-// Define a function to create a Markdown table from a vector of rows with formatting for Discord.
 pub fn create_discord_markdown_table(rows: Vec<Vec<String>>) -> String {
 	let mut result = String::new();
 
 	if rows.is_empty() {
 		return result;
 	}
 
-	// Determine the number of columns from the first row
 	let columns = rows[0].len();
 
-	// Find the maximum width for each column
 	let mut max_widths = vec![0; columns];
 	for row in &rows {
 		for (index, cell) in row.iter().enumerate() {
 			max_widths[index] =
 				std::cmp::max(max_widths[index], UnicodeWidthStr::width(cell.as_str()) + 2);
-			// Adjust for proper Unicode width
 		}
 	}
 
-	// Create the header separator
 	let header_separator: Vec<String> = max_widths.iter().map(|&width| "-".repeat(width)).collect();
 
-	// Process each row, padding each cell to the max width of its column
 	for (i, row) in rows.iter().enumerate() {
 		let padded_row: Vec<String> = row
 			.iter()
 			.enumerate()
 			.map(|(index, cell)| pad_string(cell, max_widths[index]))
 			.collect();
 
-		// Add row to the result
 		result.push_str(&format!("|{}|\n", padded_row.join("|")));
 
-		// Add the header separator after the first row (header)
 		if i == 0 {
 			result.push_str(&format!("|{}|\n", header_separator.join("|")));
 		}
 	}
 
-	// Encapsulate in a monospace code block for Discord
+	// Wrap in a fenced code block so Discord renders it monospaced.
 	format!("```\n{result}\n```")
 }