docs: add contract docstrings for exported API names (#60) - #211
Conversation
|
👋 Hi @NiranjanKumar001 — thank you so much for your first contribution to HFlow! A maintainer will review your pull request as soon as possible. In the meantime:
💡 Tip: one open pull request per contributor at a time. Issues with an assignee are taken; everything else is fair game. We are excited to have you here and appreciate your help making the project better! 🙌 |
CurationReport named a dry_run parameter that curate() does not have; the condition is output=None. TestReport.quarantined attributed the tag to a critical check verdict, which misses the carried case: a run that skips the meta stage reads the episode's cataloged quarantine and extends the same list (app.py:2043). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
kstonekuan
left a comment
kstonekuan
left a comment
There was a problem hiding this comment.
Merging. Every name #60 listed is covered, and the contracts say what the code does.
Validated on Linux: ruff check, ruff format --check, ty check, 1102 passed, 6 skipped.
Two fixups pushed to your branch (2c41d6c), both accuracy rather than style:
CurationReportsaid the manifest is None "when curate() ran withdry_run=True". There is nodry_runparameter. The condition isoutput=None(curation.py:537), which still runs the query and reports row count and coverage.TestReport.quarantinedsaid a critical check verdict marks the run. That is one of two sources. When a run skips the meta stage it reads the episode's cataloged quarantine and extends the same list (app.py:2038-2043), so a media-only run can reportquarantinedwith no check verdict in it at all. Worth knowing because that is the case the property exists to catch.
One thing from the issue you correctly did not do: InstrumentParseError is listed there but no longer exists, since the ffmpeg instrument module was refactored after the issue was filed. Nothing missing.
If you want another, the open list is here: https://github.com/Hebbian-Robotics/hflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
2 participants
Fixes #60