doc: Remove no longer correct comment
What the developer wrote
Authored by Hodlinator
doc: Remove no longer correct comment
Left over since fa7b07571f24b6def6effdd4cc1b96c7507bf959.
Co-authored-by: Lőrinc <pap.lorinc@gmail.com>
What changed, and why it matters
This commit only removes a two-line comment in a test helper file because the comment no longer matched what the function actually does. No code behavior was changed, so there is no security impact.
No action needed; this is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The change deletes a docstring ‘Return:’ block in test/functional/test_framework/test_node.py’s busy_wait_for_debug_log(). The function no longer returns the number of matched log lines (apparently changed in an earlier commit, fa7b07571f24b6def6effdd4cc1b96c7507bf959). The diff is purely documentation cleanup in the functional test framework.
Changed components
test/functional/test_framework/test_node.pyInspect captured patch +0 / −2
diff --git a/test/functional/test_framework/test_node.py b/test/functional/test_framework/test_node.py
index 1ec2fe8a..0540ca34 100755
--- a/test/functional/test_framework/test_node.py
+++ b/test/functional/test_framework/test_node.py
@@ -575,8 +575,6 @@ class TestNode():
def busy_wait_for_debug_log(self, expected_msgs, timeout=60):
"""
Block until we see a particular debug log message fragment or until we exceed the timeout.
- Return:
- the number of log lines we encountered when matching
"""
time_end = time.time() + timeout * self.timeout_factor
prev_size = self.debug_log_size(mode="rb") # Must use same mode that is used to read() below
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.