mirror of
https://github.com/Horizontal42/netsleuth.git
synced 2026-11-11 01:02:10 +03:00
docs: add docstrings to _fmt and _block functions in compare.py
This commit is contained in:
parent
98820a683c
commit
b38d91c76f
1 changed files with 20 additions and 0 deletions
|
|
@ -139,12 +139,32 @@ def diff_reports(before: dict, after: dict) -> ReportDiff:
|
||||||
|
|
||||||
|
|
||||||
def _fmt(value: Any) -> str:
|
def _fmt(value: Any) -> str:
|
||||||
|
"""Format a value for display in markdown tables.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
value: The value to format (can be None, int, float, or str).
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
An em-dash (—) for None values, a compact numeric format for
|
||||||
|
int/float values, or the string representation for other types.
|
||||||
|
"""
|
||||||
if value is None:
|
if value is None:
|
||||||
return "—"
|
return "—"
|
||||||
return f"{value:g}" if isinstance(value, (int, float)) else str(value)
|
return f"{value:g}" if isinstance(value, (int, float)) else str(value)
|
||||||
|
|
||||||
|
|
||||||
def _block(title: str, changes: list[Change]) -> list[str]:
|
def _block(title: str, changes: list[Change]) -> list[str]:
|
||||||
|
"""Render a section of changes as markdown lines.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
title: Section heading (e.g., "Identity", "Latency", "Speed").
|
||||||
|
changes: List of Change objects describing what changed.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A list of markdown lines forming the section. If there are no
|
||||||
|
changes, returns a heading with "No change." message. Otherwise
|
||||||
|
returns a markdown table with Field/Before/After/Delta columns.
|
||||||
|
"""
|
||||||
if not changes:
|
if not changes:
|
||||||
return [f"### {title}", "", "No change.", ""]
|
return [f"### {title}", "", "No change.", ""]
|
||||||
return (
|
return (
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue