Remove redundant sentences in function docs
What the developer wrote
Authored by Mitchell Bagot
Remove redundant sentences in function docs
The is_satisfied_by_* functions repeat their shorthand description in
their first extended docs sentence. The latter sentence can simply be
removed without any loss of information.
What changed, and why it matters
This commit only removes two redundant sentences from Rust documentation comments. It does not change any executable code, logic, or behavior. There is no security impact.
No action required; this is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch deletes duplicate explanatory sentences in doc comments for is_satisfied_by_height and is_satisfied_by_time in units/src/locktime/relative/mod.rs. The function signatures, implementations, error handling, and semantics remain unchanged. No code paths are modified.
Changed components
units/src/locktime/relative/mod.rs (documentation only)Inspect captured patch +0 / −6
diff --git a/units/src/locktime/relative/mod.rs b/units/src/locktime/relative/mod.rs
index 5cc4dd11..f2b68e3b 100644
--- a/units/src/locktime/relative/mod.rs
+++ b/units/src/locktime/relative/mod.rs
@@ -221,9 +221,6 @@ impl LockTime {
/// Returns true if an output with this locktime can be spent in the next block.
///
- /// If this function returns true then an output with this locktime can be spent in the next
- /// block.
- ///
/// # Errors
///
/// Returns an error if this lock is not lock-by-height.
@@ -244,9 +241,6 @@ impl LockTime {
/// Returns true if an output with this locktime can be spent in the next block.
///
- /// If this function returns true then an output with this locktime can be spent in the next
- /// block.
- ///
/// # Errors
///
/// Returns an error if this lock is not lock-by-time.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.