Skip to main content

Module naming

Module naming 

Source
Expand description

Naming-quality heuristic.

Cryptic identifiers force agents (and humans) into exhaustive search instead of targeted lookups — the article’s normalize_query vs _xfm_q2 example. This check is deliberately conservative: only clearly non-descriptive function names are reported, keeping the signal high and false positives near zero. Pure + deterministic so it is safe for read-time annotation (#498).

Structs§

NamingFinding
A function whose name is judged cryptic, with a human-readable reason.

Functions§

cryptic_reason
Returns a reason string if name is cryptic, else None. Pure and unit-tested; this is the single source of truth for the heuristic.
naming_findings
Report cryptic function names in source of the given file extension. Returns None when tree-sitter is disabled or the extension is unsupported.