Most functions in tsauditor/profiler/, tsauditor/anomaly/, and
tsauditor/leakage/ have a docstring describing parameters and return
values, but none currently show a usage example inline.
What's needed: pick one or two audit_* functions (e.g.
audit_frequency, audit_point_anomalies) and add an Examples section
to the docstring, in the same style as numpy/pandas docstrings — a short
doctest-style snippet showing a call and what it returns. You don't
need to cover every function in one PR; even improving one or two
functions is a useful, mergeable contribution.
Why this is approachable: this is documentation-only, no logic
changes. Looking at how tsauditor/leakage/equivalence.py's module-level
docstring explains its reasoning is a good model for the level of clarity
to aim for, even though that one doesn't yet have a >>> example either adding one there would also be useful.
Most functions in tsauditor/profiler/, tsauditor/anomaly/, and
tsauditor/leakage/ have a docstring describing parameters and return
values, but none currently show a usage example inline.
What's needed:pick one or two audit_* functions (e.g.audit_frequency, audit_point_anomalies) and add an Examples section
to the docstring, in the same style as numpy/pandas docstrings — a short
Why this is approachable:this is documentation-only, no logicchanges. Looking at how tsauditor/leakage/equivalence.py's module-level
docstring explains its reasoning is a good model for the level of clarity
to aim for, even though that one doesn't yet have a
>>>example either adding one there would also be useful.