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
@@ -12,7 +12,7 @@ pub const VERSION: u8 = 1;
|
||||
/// Maximum backtrace frames captured in the signal handler.
|
||||
pub const MAX_FRAMES: usize = 64;
|
||||
|
||||
/// Length of the null-padded version string field.
|
||||
/// Length of the null-`padded` version string field.
|
||||
pub const VERSION_STRING_LEN: usize = 32;
|
||||
|
||||
/// Fixed header size (before the variable-length frames array).
|
||||
@@ -26,7 +26,7 @@ pub const VERSION_STRING_LEN: usize = 32;
|
||||
/// - pid: 4 bytes (u32, little-endian)
|
||||
/// - timestamp: 8 bytes (u64, little-endian)
|
||||
/// - n_frames: 2 bytes (u16, little-endian)
|
||||
/// - app_version: 32 bytes (null-padded UTF-8)
|
||||
/// - app_version: 32 bytes (null-`padded` UTF-8)
|
||||
pub const HEADER_SIZE: usize = 4 + 1 + 1 + 4 + 8 + 4 + 8 + 2 + VERSION_STRING_LEN;
|
||||
|
||||
/// Total maximum file size: header + 64 frames * 8 bytes each.
|
||||
@@ -176,8 +176,9 @@ mod tests {
|
||||
unsafe {
|
||||
let mut offset = writer::write_header(
|
||||
&mut buf,
|
||||
10, // SIGBUS on macOS
|
||||
2, // BUS_ADRERR
|
||||
// SIGBUS on macOS
|
||||
10,
|
||||
2,
|
||||
0x7f8a_1234_0000,
|
||||
42,
|
||||
1_712_678_587,
|
||||
|
||||
Reference in new issue
Block a user