mirror of
https://github.com/Horizontal42/netsleuth.git
synced 2026-11-11 01:02:10 +03:00
docs: add docstring to path_findings
This commit is contained in:
parent
28ec6b86fa
commit
643f203a56
1 changed files with 9 additions and 0 deletions
|
|
@ -136,6 +136,15 @@ def latency_findings(pings: list[PingResult], t: Thresholds) -> list[Finding]:
|
||||||
|
|
||||||
|
|
||||||
def path_findings(trace: TraceResult) -> 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:
|
if not trace.hops:
|
||||||
return [
|
return [
|
||||||
Finding(
|
Finding(
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue