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:
1 parent
ff0fb56c67
commit
a02b555e66
1458 files changed
+10729
-21750
No files matched your search
@@ -105,37 +105,6 @@ impl SourceMap {
|
||||
}
|
||||
}
|
||||
|
||||
// ## Restoring Byte-Level Source Maps (if ever needed)
|
||||
// Ratatui path tracks line-level mapping only (`line_source_map`) for
|
||||
// copy/selection. Byte-level `SourceMap` is unused here (~6% faster).
|
||||
//
|
||||
// The ratatui rendering path currently only tracks line-level source mapping
|
||||
// (`line_source_map`), which is sufficient for copy/selection operations.
|
||||
// Byte-level `SourceMap` was removed for simplicity and ~6% speedup.
|
||||
//
|
||||
// To restore byte-level source maps:
|
||||
//
|
||||
// 1. Add field to MarkdownRenderOutput and MarkdownRenderView:
|
||||
// ```
|
||||
// pub source_map: SourceMap,
|
||||
// ```
|
||||
//
|
||||
// 2. In render_ratatui(), add tracking variables:
|
||||
// ```
|
||||
// let mut source_map = SourceMap::new();
|
||||
// let mut rendered_offset: usize = 0;
|
||||
// ```
|
||||
//
|
||||
// 3. For each text segment emitted, record the mapping:
|
||||
// ```
|
||||
// source_map.add(rendered_offset, source_start..source_end);
|
||||
// rendered_offset += emitted_text.len();
|
||||
// ```
|
||||
//
|
||||
// 4. In streaming.rs, update FrozenState to track:
|
||||
// ```
|
||||
// source_map_len: usize,
|
||||
// rendered_bytes: usize,
|
||||
// ```
|
||||
//
|
||||
// 5. Use SourceMap::extend_with_offsets() to merge tail source maps.
|
||||
//
|
||||
// See git history for the removed implementation.
|
||||
Reference in new issue
Block a user