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
@@ -22,8 +22,6 @@ pub(crate) struct LocalRef<T> {
|
||||
ptr: *const T,
|
||||
}
|
||||
impl<T> LocalRef<T> {
|
||||
/// Create a `LocalRef` from a shared reference.
|
||||
///
|
||||
/// # Safety contract (enforced by the caller, not by the type system)
|
||||
///
|
||||
/// The referenced `T` must live for the entire duration of the `LocalSet`
|
||||
@@ -31,8 +29,6 @@ impl<T> LocalRef<T> {
|
||||
pub(crate) fn new(val: &T) -> Self {
|
||||
Self { ptr: val as *const T }
|
||||
}
|
||||
/// Dereference back to `&T`.
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// Safe because the caller of `new()` guarantees the pointee is alive
|
||||
|
||||
Reference in new issue
Block a user