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
@@ -1,15 +1,12 @@
|
||||
//! Bazel runfiles helpers for locating test data.
|
||||
//! Bazel runfiles helpers for test data.
|
||||
//!
|
||||
//! Under `bazel test`, source files and test data are accessed via the
|
||||
//! *runfiles* tree. Under `cargo test`, `CARGO_MANIFEST_DIR` provides
|
||||
//! the crate root. The [`crate_root!`] macro abstracts over both.
|
||||
//! Under `bazel test`, data lives in the runfiles tree; under `cargo test`,
|
||||
//! `CARGO_MANIFEST_DIR` is the crate root. [`crate_root!`] covers both.
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
/// Try to resolve a runfiles path to an absolute directory.
|
||||
///
|
||||
/// Returns `Some(path)` when running under Bazel (with the `bazel` feature
|
||||
/// enabled) and the runfiles entry exists, `None` otherwise.
|
||||
/// Resolve a runfiles path to an absolute directory when the `bazel` feature
|
||||
/// is on and the entry exists; otherwise `None`.
|
||||
pub fn try_resolve_runfiles(_path: &str) -> Option<PathBuf> {
|
||||
#[cfg(feature = "bazel")]
|
||||
{
|
||||
@@ -22,11 +19,8 @@ pub fn try_resolve_runfiles(_path: &str) -> Option<PathBuf> {
|
||||
}
|
||||
}
|
||||
|
||||
/// Resolve the crate root directory, working under both `bazel test` and
|
||||
/// `cargo test`.
|
||||
///
|
||||
/// Under Bazel the path is resolved via runfiles; under Cargo it falls back
|
||||
/// to `CARGO_MANIFEST_DIR`.
|
||||
/// Crate root under both `bazel test` (runfiles) and `cargo test`
|
||||
/// (`CARGO_MANIFEST_DIR`).
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
|
||||
Reference in new issue
Block a user