docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment guidelines: delete redundant restatements, decorative banners, change narration, and end-of-line comments; keep and tighten the crucial ones (invariants, bug rationale, SAFETY blocks, ported-source attribution). No functional code changed. Every edit is proven comment-only against the prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a separate doctest-fence check. Where removing a comment made rustfmt or clippy want to re-lay-out adjacent code, the minimal triggering comment is restored so code tokens stay byte-identical. Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy --workspace --all-targets (0 warnings). Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for these guidelines (flags banners, end-of-line comments, change narration, and commented-out code).
This commit is contained in:
@@ -48,8 +48,6 @@ const MEASURE_TIME: Duration = Duration::from_secs(3);
|
||||
const MEASURE_TIME_HEAVY: Duration = Duration::from_secs(5);
|
||||
const RENDER_WIDTH: u16 = 120;
|
||||
|
||||
// ── Fixtures ────────────────────────────────────────────────────────────────
|
||||
|
||||
struct Fixture {
|
||||
_dir: TempDir,
|
||||
path: PathBuf,
|
||||
@@ -170,8 +168,6 @@ fn make_hunk_at(file_lines: &[&str], close_i: usize) -> Option<DiffHunk> {
|
||||
}
|
||||
}
|
||||
|
||||
// ── Non-product prefix baseline ─────────────────────────────────────────────
|
||||
|
||||
fn own_ranges(ranges: Vec<(SyntectStyle, &str)>) -> Vec<(SyntectStyle, String)> {
|
||||
ranges.into_iter().map(|(s, t)| (s, t.to_owned())).collect()
|
||||
}
|
||||
@@ -233,8 +229,6 @@ fn estimate_style_map_bytes(map: &HashMap<usize, Vec<(ratatui::style::Style, Str
|
||||
bytes
|
||||
}
|
||||
|
||||
// ── Bench groups ────────────────────────────────────────────────────────────
|
||||
|
||||
fn configure_fast(group: &mut criterion::BenchmarkGroup<'_, criterion::measurement::WallTime>) {
|
||||
group
|
||||
.sample_size(SAMPLE_SIZE)
|
||||
@@ -287,7 +281,6 @@ fn bench_matrix(c: &mut Criterion) {
|
||||
let config = DiffRenderConfig::default();
|
||||
let syntect = get_syntect();
|
||||
|
||||
// ── 500L + prefix (own heavy config) ────────────────────────────────────
|
||||
{
|
||||
let fx = gen_python_fixture(500, 8);
|
||||
let file_lines: Vec<&str> = fx.file_text.lines().collect();
|
||||
@@ -308,7 +301,6 @@ fn bench_matrix(c: &mut Criterion) {
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ── 10kL session (no prefix) ────────────────────────────────────────────
|
||||
{
|
||||
let fx = gen_python_fixture(10_000, 40);
|
||||
let styles = compute_file_scoped_styles(fx.path(), &fx.file_text, &fx.hunks)
|
||||
|
||||
Reference in New Issue
Block a user