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,50 +1,31 @@
//! XDG-compliant path resolution for config and data directories.
use std::path::PathBuf;
/// Get the path to the config file.
///
/// Resolution order:
/// 1. CLI flag override (if provided)
/// 2. LORE_CONFIG_PATH environment variable
/// 3. XDG default (~/.config/lore/config.json)
/// 4. Local fallback (./lore.config.json) if exists
/// 5. Returns XDG default even if not exists
pub fn get_config_path(cli_override: Option<&str>) -> PathBuf {
// 1. CLI flag override
if let Some(path) = cli_override {
return PathBuf::from(path);
}
// 2. Environment variable
if let Ok(path) = std::env::var("LORE_CONFIG_PATH") {
return PathBuf::from(path);
}
// 3. XDG default
let xdg_path = get_xdg_config_dir().join("lore").join("config.json");
if xdg_path.exists() {
return xdg_path;
}
// 4. Local fallback (for development)
let local_path = PathBuf::from("lore.config.json");
if local_path.exists() {
return local_path;
}
// 5. Return XDG path (will trigger not-found error if missing)
xdg_path
}
/// Get the data directory path.
/// Uses XDG_DATA_HOME or defaults to ~/.local/share/lore
pub fn get_data_dir() -> PathBuf {
get_xdg_data_dir().join("lore")
}
/// Get the database file path.
/// Uses config override if provided, otherwise uses default in data dir.
pub fn get_db_path(config_override: Option<&str>) -> PathBuf {
if let Some(path) = config_override {
return PathBuf::from(path);
@@ -52,8 +33,6 @@ pub fn get_db_path(config_override: Option<&str>) -> PathBuf {
get_data_dir().join("lore.db")
}
/// Get the log directory path.
/// Uses config override if provided, otherwise uses default in data dir.
pub fn get_log_dir(config_override: Option<&str>) -> PathBuf {
if let Some(path) = config_override {
return PathBuf::from(path);
@@ -61,8 +40,6 @@ pub fn get_log_dir(config_override: Option<&str>) -> PathBuf {
get_data_dir().join("logs")
}
/// Get the backup directory path.
/// Uses config override if provided, otherwise uses default in data dir.
pub fn get_backup_dir(config_override: Option<&str>) -> PathBuf {
if let Some(path) = config_override {
return PathBuf::from(path);
@@ -70,7 +47,6 @@ pub fn get_backup_dir(config_override: Option<&str>) -> PathBuf {
get_data_dir().join("backups")
}
/// Get XDG config directory, falling back to ~/.config
fn get_xdg_config_dir() -> PathBuf {
std::env::var("XDG_CONFIG_HOME")
.map(PathBuf::from)
@@ -81,7 +57,6 @@ fn get_xdg_config_dir() -> PathBuf {
})
}
/// Get XDG data directory, falling back to ~/.local/share
fn get_xdg_data_dir() -> PathBuf {
std::env::var("XDG_DATA_HOME")
.map(PathBuf::from)
@@ -102,8 +77,4 @@ mod tests {
let path = get_config_path(Some("/custom/path.json"));
assert_eq!(path, PathBuf::from("/custom/path.json"));
}
// Note: env var tests removed - mutating process-global env vars
// in parallel tests is unsafe in Rust 2024. The env var code path
// is trivial (std::env::var) and doesn't warrant the complexity.
}