docs: document doctor finding codes; correct the B-frame conformance claim - #56
Closed
chintondutta wants to merge 1 commit into
Closed
Conversation
…claim FORMAT.md's conformance item 4 implied hflow doctor checks for B-frames -- it doesn't (no B-frame detection exists in doctor.py); marked it a convention not yet checked. Added a table of all 16 finding codes emitted by doctor.py (grepped collector.add(...) call sites to enumerate them), each with its level and meaning, since Finding.code is documented as a stable identifier but was listed nowhere.
|
👋 Hi @chintondutta — thanks for the contribution! To keep starter issues available You already have #52 open, so this one is being closed automatically. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #10.
Two gaps
1.
docs/FORMAT.mdclaimed a check the doctor doesn't perform. Conformance item 4 stated "no B-frames" as part of whathflow doctorchecks.src/hflow/doctor.pyverifies the h264 format, AUD-delimited access units, SPS/PPS on keyframes, and keyframe-first ordering -- but has no B-frame detection. Reworded the item to keep no-B-frames as a stated convention (linked to the existing "In-band video" section that already documents it) while being explicit that the doctor doesn't check it yet.2. The doctor's finding codes were documented nowhere.
Finding.codeis declared a "stable kebab-case identifier" but no page listed them. Enumerated all 16 by greppingcollector.add(indoctor.py(the issue estimated ~14; there are 16) and added a table under a new "Doctor finding codes" section indocs/FORMAT.md: code, level, one-line meaning, matching each call site's actual message.Docs only, no code changes.
Testing
(lychee wasn't on PATH in this sandbox; ran it via the official Docker image instead of installing.)