docs: add docstring to path_findings

This commit is contained in:
qwen.ai[bot] 2026-08-12 14:50:41 +00:00
parent 28ec6b86fa
commit 643f203a56

View file

@ -136,6 +136,15 @@ def latency_findings(pings: list[PingResult], t: Thresholds) -> list[Finding]:
def path_findings(trace: TraceResult) -> list[Finding]:
"""Generate findings from traceroute results.
Args:
trace: A TraceResult object containing hops and metadata.
Returns:
A list of Finding objects describing issues like incomplete paths,
sustained packet loss starting at a specific hop, or missing data.
"""
if not trace.hops:
return [
Finding(