docs: fix broken Data Streams doc link in README - #3180
Closed
xiaoyaoqilan wants to merge 2 commits into
Closed
Conversation
The WHITELIST path comparisons in test_get_logger, test_no_sections,
and test_no_dunder_new compare `rel_path` against "/" - hardcoded paths.
But `rel_path` is built from `os.path.relpath` / `Path.relative_to`,
which yield OS-native separators ("\\" on Windows). On any OS where
`os.sep != "/"`, the comparison never matches, so the whitelist is
dead code: it masks real violations and reports spurious ones.
test_no_get_logger currently fails on Windows with 8 false positives
(the 8 whitelisted `logging.getLogger` usages all get flagged). The
same latent bug affects test_no_sections (docker_module.py sentinel)
and test_no_dunder_new (mujoco __new__).
Normalize `rel_path` to forward slashes before comparing. No-op on
Linux/macOS, correct everywhere. Verified: the three checks now pass
on Windows and are unchanged on POSIX.
README pointed to docs/usage/data_streams/README.md, which does not exist. The actual file is index.md. Redirect the link so it resolves.
xiaoyaoqilan
requested review from
Dreamsorcerer,
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
July 25, 2026 06:49
Contributor
Greptile SummaryCorrects the README’s Data Streams link and makes three codebase-check whitelist comparisons platform-independent.
Confidence Score: 5/5The PR appears safe to merge with no actionable defects identified. The corrected documentation target exists and follows neighboring link conventions, while all three path changes consistently normalize OS-native separators before exact whitelist comparisons. Important Files Changed
Reviews (1): Last reviewed commit: "docs: fix broken Data Streams doc link" | Re-trigger Greptile |
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.
README pointed to
docs/usage/data_streams/README.md, which does not exist. The actual file isindex.md. Redirect the link so it resolves.