chore(comments): strip ai-sounding and restate-the-code comments across workspace

Author: DevYukine

api/src/error/mod.rs

@@ -83,5 +83,4 @@ impl ResponseError for Error {
 	}
 }
 
-// Short hand alias, which allows you to use just Result<T>
 pub type Result<T> = std::result::Result<T, Error>;

api/src/lib.rs

@@ -503,7 +503,7 @@ fn build_screenscraper_client(
 /// Returns `None` when EMUREADY_ENABLED is unset or not "true". The EmuReady
 /// API is open and unauthenticated for read endpoints; the flag exists so
 /// existing deployments do not silently start hitting an external service on
-/// next deploy. Matching only — no proxy routes are exposed.
+/// next deploy. Matching only. No proxy routes are exposed.
 fn build_emuready_client(
 	http: Client,
 	redis_conn: redis::aio::MultiplexedConnection,

api/src/openapi/mod.rs

@@ -548,13 +548,11 @@ pub struct ApiDoc;
 pub fn create_openapi() -> utoipa::openapi::OpenApi {
 	let mut openapi = ApiDoc::openapi();
 
-	// Extract existing schemas if already generated
 	let existing_components = openapi
 		.components
 		.take()
 		.unwrap_or_else(Components::default);
 
-	// Build new components with security scheme
 	let new_components = ComponentsBuilder::from(existing_components)
 		.security_scheme(
 			"bearer_auth",
@@ -567,7 +565,6 @@ pub fn create_openapi() -> utoipa::openapi::OpenApi {
 		)
 		.build();
 
-	// Assign merged components back to OpenAPI doc
 	openapi.components = Some(new_components);
 
 	openapi

service/src/http/download.rs

@@ -11,7 +11,6 @@ use tokio::fs::File;
 use tokio::io::AsyncWriteExt;
 
 lazy_static! {
-	// Define the regex pattern for extracting the filename
 	static ref FILENAME_REGEX: Regex = Regex::new(r#"filename\*?=(?:UTF-8''|")?([^";]+)"#).unwrap();
 }
 
@@ -71,9 +70,7 @@ pub async fn download_file(
 	}
 }
 
-// Function to extract the filename from Content-Disposition header value
 fn extract_filename(content_disposition: &str) -> Option<String> {
-	// Using the cached regex to capture the filename part
 	if let Some(captures) = FILENAME_REGEX.captures(content_disposition) {
 		return captures.get(1).map(|c| c.as_str().to_string());
 	}

service/src/identification/mod.rs

@@ -95,13 +95,9 @@ pub async fn identify_game_and_metadata_mappings(
 	}
 }
 
-/// Walk the supported match types in order (sha256, sha1, md5, name+size) and return the first
-/// hit, together with whether the hit was served from cache. If every hash that could have been
-/// checked produced a cached-but-empty result, surface a `Cached(None)`; otherwise `NonCached(None)`.
-///
-/// Cache-coherence bookkeeping lives in [`IdentifyAggregator`]; this fn is
-/// the impure dispatch shell that runs the cache lookups and records the
-/// per-attempt metric.
+/// Tries each match type in order (sha256, sha1, md5, name+size) and returns
+/// the first hit. When every attempted hash produced a cached-but-empty
+/// result the outcome collapses to `Cached(None)`, otherwise `NonCached(None)`.
 async fn identify_game(
 	search: &GameFileMatchSearch,
 	redis_conn: &mut MultiplexedConnection,

service/src/identification/protocol.rs

@@ -33,10 +33,6 @@ impl IdentifyAggregator {
 	}
 
 	/// Fold one per-match-type cache outcome into the running tally.
-	///
-	/// `Break(result)` means the caller should return `result` immediately
-	/// (a hit was found, served from cache or computed). `Continue(())`
-	/// means the caller should move on to the next match type.
 	pub fn observe(
 		&mut self,
 		match_type: GameMatchType,
@@ -55,12 +51,10 @@ impl IdentifyAggregator {
 
 	/// Collapse the running tally into a final cache outcome.
 	///
-	/// Returns `Cached(None)` only when `cached_but_empty == expected_count`
-	/// and `expected_count != 0`. Note that `cached_but_empty` is bumped on
-	/// every `Cached(None)` outcome including the filename+size attempt,
-	/// while `expected_count` only counts hash fields. The asymmetry is a
-	/// known wrinkle preserved verbatim from the pre-refactor logic; see
-	/// the test module for the pinned behavior.
+	/// Returns `Cached(None)` only when every hash attempt produced
+	/// `Cached(None)`. `cached_but_empty` is bumped on every `Cached(None)`
+	/// outcome including the filename+size attempt, while `expected_count`
+	/// only counts hash fields; see the test module for the pinned behavior.
 	pub fn finalize(self) -> CacheStatus<Option<(GameMatchType, IdentifyEntry)>> {
 		if self.cached_but_empty == self.expected_count && self.cached_but_empty != 0 {
 			Cached(None)
@@ -148,7 +142,7 @@ mod tests {
 	/// filename+size attempt is also cached empty, `cached_but_empty`
 	/// (3 hashes + 1 filename = 4) no longer equals `expected_count`
 	/// (3 hashes), so the result is `NonCached(None)` even though every
-	/// attempt was cached. Worth revisiting in a follow-up.
+	/// attempt was cached.
 	#[test]
 	fn filename_size_cached_empty_breaks_cached_none_collapse() {
 		let mut agg = IdentifyAggregator::new(3);
@@ -165,8 +159,7 @@ mod tests {
 
 	/// Pins a second wrinkle: when only filename+size is attempted (no
 	/// hashes) and it returns Cached(None), the `expected_count != 0`
-	/// guard in `finalize` forces `NonCached(None)`. Also worth a
-	/// follow-up.
+	/// guard in `finalize` forces `NonCached(None)`.
 	#[test]
 	fn only_filename_size_cached_empty_yields_noncached_none() {
 		let mut agg = IdentifyAggregator::new(0);

service/src/ingestion/parser/import.rs

@@ -117,7 +117,6 @@ pub async fn parse_and_import_dat_file(
 							})
 							.collect();
 
-						// Delete existing files that are not in the new files
 						for file in existing_files.iter() {
 							let identifier = (
 								&file.file_name,
@@ -134,7 +133,6 @@ pub async fn parse_and_import_dat_file(
 
 						let mut to_insert = vec![];
 
-						// Insert new files that are not in the existing files
 						for rom in game.rom.iter() {
 							let identifier = (
 								&rom.name,
@@ -217,10 +215,9 @@ fn parse_company_and_platform(
 ) -> anyhow::Result<(Option<String>, String, Vec<String>)> {
 	let mut dat_header = dat.header.name.clone();
 
-	// Remove Arcade - from the name as its not a company or system
+	// Remove Arcade - from the name because it is not a company or system
 	dat_header = dat_header.replace("Arcade - ", "");
 
-	// Remove subset prefix if present
 	if let Some(subset) = &dat.header.subset {
 		let subset_prefix = format!("{subset} - ");
 		if dat_header.starts_with(&subset_prefix) {
@@ -241,25 +238,21 @@ fn parse_company_and_platform(
 
 	match split.len() {
 		1 => {
-			// Single part - it's the platform, no company
 			platform = split[0].to_string();
 		}
 		2 => {
-			// Two parts - company and platform
 			company = Some(split[0].to_string());
 			platform = split[1].to_string();
 		}
 		_ => {
-			// Three or more parts
 			company = Some(split[0].to_string());
 
-			// Join the remaining parts
 			let remaining_parts = split[1..].to_vec();
 
-			// Check if this looks like extra metadata (contains brackets, "NKit", etc)
+			// Stop joining parts onto the platform once one looks like extra
+			// metadata (bracketed tags, NKit, RVZ, and similar).
 			let mut platform_parts = Vec::new();
 			for part in remaining_parts {
-				// Stop adding to platform if we hit what looks like metadata
 				if part.contains('[')
 					|| part.contains("NKit")
 					|| part.contains("RVZ")
@@ -282,10 +275,8 @@ fn parse_company_and_platform(
 
 	// Remove company name from platform if it appears there for GameCube
 	if let Some(ref company_name) = company {
-		// Remove "Company Platform" -> "Platform"
 		if platform.starts_with(company_name) && platform.to_lowercase().contains("gamecube") {
 			let after_company = platform.strip_prefix(company_name).unwrap_or(&platform);
-			// Clean up any leading spaces or separators
 			platform = after_company
 				.trim_start_matches(' ')
 				.trim_start_matches('-')
@@ -297,7 +288,6 @@ fn parse_company_and_platform(
 		let company_no_spaces = company_name.replace(' ', "");
 		if platform.starts_with(&company_no_spaces) && platform.len() > company_no_spaces.len() {
 			let potential_platform = &platform[company_no_spaces.len()..];
-			// Check if the next character is uppercase (indicating camelCase split)
 			if potential_platform
 				.chars()
 				.next()
@@ -309,10 +299,8 @@ fn parse_company_and_platform(
 		}
 	}
 
-	// Remove version from platform if present
 	platform = platform.replace(&format!(" ({version})"), "");
 
-	// Extract tags from platform
 	let mut clean_platform = platform.clone();
 	for capture in DAT_TAG_REGEX.captures_iter(&platform) {
 		if let Some(tag_match) = capture.get(1) {
@@ -337,7 +325,6 @@ fn parse_company_and_platform(
 		let number_str = number_match.as_str();
 		let number = number_str.parse::<u32>().unwrap_or(1);
 
-		// Convert PS1, PS2, PS3, etc. to PlayStation 1, PlayStation 2, etc.
 		platform = format!("PlayStation {number}");
 	}
 

service/src/matching/manual.rs

@@ -90,7 +90,6 @@ async fn apply_manual_entity_match(
 				"Overwriting existing mapping for {}: {entity_id}",
 				target.label()
 			);
-			// TODO: decide how to notify the user that this entry is already matched
 		}
 
 		if let Some(provider_id) = &mapping.provider_id
@@ -186,7 +185,6 @@ pub async fn apply_manual_game_match_by_game(
 
 	let mut games_to_update = vec![];
 
-	// Find all parents and children of the same game
 	for game in games {
 		if let Some(parent) = find_game_parent(&game, db_conn).await? {
 			debug!("Found parent game: {}", parent.id);
@@ -230,7 +228,6 @@ pub async fn apply_manual_game_match_by_game(
 				&& mapping.match_type != MatchTypeEnum::None
 			{
 				debug!("Overwriting existing mapping for game: {}", game.id);
-				// TODO: decide how to notify the user that this entry is already matched
 			}
 
 			if let Some(provider_id) = &mapping.provider_id

service/src/model/match_result.rs

@@ -78,10 +78,10 @@ impl GameMatchType {
 	/// `None` for [`GameMatchType::NoMatch`] (not cached).
 	///
 	/// Note: `FileNameAndSize` returns `"filename_size"` here while
-	/// [`Self::metric_label`] returns `"filename"`. The mismatch predates
-	/// this method (cache hit/miss metrics used `"filename_size"`; identify
-	/// attempt metrics used `"filename"`) and is preserved to keep existing
-	/// Prometheus series stable. Future cleanup should align them.
+	/// [`Self::metric_label`] returns `"filename"`. Cache hit/miss metrics
+	/// use `"filename_size"` and identify attempt metrics use `"filename"`;
+	/// the two segments stay distinct to keep existing Prometheus series
+	/// stable.
 	pub fn cache_segment(&self) -> Option<&'static str> {
 		match self {
 			GameMatchType::SHA256 => Some("sha256"),

service/src/providers/igdb/mod.rs

@@ -1268,7 +1268,7 @@ impl IgdbClient {
 		}
 
 		let rate_limited_future = self.service.lock().await.ready().await?.call(req);
-		// MutexGuard has to have been dropped here, so it's 2 statements
+		// Bind the future to a local so the MutexGuard drops before .await.
 		let res = rate_limited_future.await?;
 
 		let body = res.text().await?;