refactor: Remove redundant doc comments throughout codebase

Removes module-level doc comments (//! lines) and excessive inline doc
comments that were duplicating information already evident from:
- Function/struct names (self-documenting code)
- Type signatures (the what is clear from types)
- Implementation context (the how is clear from code)

Affected modules:
- cli/* - Removed command descriptions duplicating clap help text
- core/* - Removed module headers and obvious function docs
- documents/* - Removed extractor/regenerator/truncation docs
- embedding/* - Removed pipeline and chunking docs
- gitlab/* - Removed client and transformer docs (kept type definitions)
- ingestion/* - Removed orchestrator and ingestion docs
- search/* - Removed FTS and vector search docs

Philosophy: Code should be self-documenting. Comments should explain
"why" (business decisions, non-obvious constraints) not "what" (which
the code itself shows). This change reduces noise and maintenance burden
while keeping the codebase just as understandable.

Retains comments for:
- Non-obvious business logic
- Important safety invariants
- Complex algorithm explanations
- Public API boundaries where generated docs matter

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Taylor Eernisse
2026-02-05 00:04:32 -05:00
parent 976ad92ef0
commit 65583ed5d6
57 changed files with 143 additions and 1693 deletions

View File

@@ -1,39 +1,24 @@
//! Time utilities for consistent timestamp handling.
//!
//! All database *_at columns use milliseconds since epoch for consistency.
use chrono::{DateTime, Utc};
/// Convert GitLab API ISO 8601 timestamp to milliseconds since epoch.
pub fn iso_to_ms(iso_string: &str) -> Option<i64> {
DateTime::parse_from_rfc3339(iso_string)
.ok()
.map(|dt| dt.timestamp_millis())
}
/// Convert milliseconds since epoch to ISO 8601 string.
pub fn ms_to_iso(ms: i64) -> String {
DateTime::from_timestamp_millis(ms)
.map(|dt| dt.to_rfc3339())
.unwrap_or_else(|| "Invalid timestamp".to_string())
}
/// Get current time in milliseconds since epoch.
pub fn now_ms() -> i64 {
Utc::now().timestamp_millis()
}
/// Parse a relative time string (7d, 2w, 1m) or ISO date into ms epoch.
///
/// Returns the timestamp as of which to filter (cutoff point).
/// - `7d` = 7 days ago
/// - `2w` = 2 weeks ago
/// - `1m` = 1 month ago (30 days)
/// - `2024-01-15` = midnight UTC on that date
pub fn parse_since(input: &str) -> Option<i64> {
let input = input.trim();
// Try relative format: Nd, Nw, Nm
if let Some(num_str) = input.strip_suffix('d') {
let days: i64 = num_str.parse().ok()?;
return Some(now_ms() - (days * 24 * 60 * 60 * 1000));
@@ -49,25 +34,20 @@ pub fn parse_since(input: &str) -> Option<i64> {
return Some(now_ms() - (months * 30 * 24 * 60 * 60 * 1000));
}
// Try ISO date: YYYY-MM-DD
if input.len() == 10 && input.chars().filter(|&c| c == '-').count() == 2 {
let iso_full = format!("{input}T00:00:00Z");
return iso_to_ms(&iso_full);
}
// Try full ISO 8601
iso_to_ms(input)
}
/// Convert ISO 8601 timestamp to milliseconds with strict error handling.
/// Returns Err with a descriptive message if the timestamp is invalid.
pub fn iso_to_ms_strict(iso_string: &str) -> Result<i64, String> {
DateTime::parse_from_rfc3339(iso_string)
.map(|dt| dt.timestamp_millis())
.map_err(|_| format!("Invalid timestamp: {}", iso_string))
}
/// Convert optional ISO 8601 timestamp to optional milliseconds (strict).
pub fn iso_to_ms_opt_strict(iso_string: &Option<String>) -> Result<Option<i64>, String> {
match iso_string {
Some(s) => iso_to_ms_strict(s).map(Some),
@@ -75,7 +55,6 @@ pub fn iso_to_ms_opt_strict(iso_string: &Option<String>) -> Result<Option<i64>,
}
}
/// Format milliseconds epoch to human-readable full datetime.
pub fn format_full_datetime(ms: i64) -> String {
DateTime::from_timestamp_millis(ms)
.map(|dt| dt.format("%Y-%m-%d %H:%M UTC").to_string())
@@ -101,7 +80,7 @@ mod tests {
#[test]
fn test_now_ms() {
let now = now_ms();
assert!(now > 1700000000000); // After 2023
assert!(now > 1700000000000);
}
#[test]
@@ -109,7 +88,7 @@ mod tests {
let now = now_ms();
let seven_days = parse_since("7d").unwrap();
let expected = now - (7 * 24 * 60 * 60 * 1000);
assert!((seven_days - expected).abs() < 1000); // Within 1 second
assert!((seven_days - expected).abs() < 1000);
}
#[test]
@@ -132,7 +111,6 @@ mod tests {
fn test_parse_since_iso_date() {
let ms = parse_since("2024-01-15").unwrap();
assert!(ms > 0);
// Should be midnight UTC on that date
let expected = iso_to_ms("2024-01-15T00:00:00Z").unwrap();
assert_eq!(ms, expected);
}