docs: clean up stale TODOs and fix filter function documentation - #287
Draft
toddr-bot wants to merge 3 commits into
Draft
docs: clean up stale TODOs and fix filter function documentation#287toddr-bot wants to merge 3 commits into
toddr-bot wants to merge 3 commits into
Conversation
Remove resolved TODO comments (EINTR test exists since t/eintr.t, result tests exist since t/result.t), rewrite new_string_source and new_string_sink POD with accurate descriptions, and remove redundant _assert_finished checks in full_results(). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- "input our output" → "input or output" in FILTERS section - "pyt's" → "pty's" in harness parser comments (2 occurrences) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace placeholder "I think it takes" and "TODO: Needs confirmation" docs with accurate descriptions based on the actual code behavior. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
What
Removes stale TODO comments and fixes undocumented filter function POD.
Why
Four TODOs referenced work that was completed long ago (EINTR tests exist
in
t/eintr.t, result tests exist int/result.t), and thenew_string_source/
new_string_sinkdocs said "TODO: Needs confirmation" despite being stableAPI used by the test infrastructure. The redundant
_assert_finishedchecksin
full_results()duplicated the same assertions already made by the sharedhelper.
How
_select_loop(resolved byt/eintr.t)t/result.t)new_string_sourcePOD: documents scalar-ref mode vs list mode, return valuesnew_string_sinkPOD: documents accumulation behaviorcroaklines infull_results()that duplicated_assert_finishedTesting
863/863 subtests pass. Only pre-existing
t/pty.tfailure (IO::Pty version).🤖 Generated with Claude Code