LowFile-scopeRust Plug & play

Use item docs (///) and module/crate docs (!//) with examples

Document public items with /// and modules/crates with //!; include minimal runnable examples that pass doctests where applicable.

Why this matters

Rustdoc renders examples and validates them as doctests.

Side-by-side examples engineers can pattern-match during review.

Avoid

pub fn sum(a: i32, b: i32) -> i32 { a + b }

Prefer

/// Add two integers.
///
/// # Examples
/// 
/// assert_eq!(sum(2, 3), 5);
/// 
pub fn sum(a: i32, b: i32) -> i32 { a + b }

Good

//! Utilities for math operations.

Bad

// Utilities for math operations.

From the same buckets as this rule.

Critical
Avoid Returning Null in Non-Async Task Methods
Returning null from a Task or Task<T> method causes a NullReferenceException if awaited. Use Task.CompletedTask or Task.FromResult<T>(null) instead.
error-handlingreadability-refactor+1
Critical
Prefer `str.replace()` Over `re.sub()` for Simple Cases
Detect uses of `re.sub()` where regular expressions are not needed. For simple string replacements, `str.replace()` is more efficient and should be used instead.
performance-efficiencystack-python+1
Critical
Use Factory Method Injection in `@Configuration` Classes
Ensure that factory method injection is used in `@Configuration` classes instead of `@Autowired` field injection.
module-architecturestyle-conventions