From af7fff25d4435b625f1c103144f25a64b06ac552 Mon Sep 17 00:00:00 2001 From: Alex Huszagh Date: Thu, 6 Feb 2025 14:29:06 -0600 Subject: [PATCH] Add patches for dependencies with TODOs in the docs. --- CHANGELOG | 1 + scripts/docs.py | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 10eb2883..93f1ec98 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed +- Patch doctests with TODOs in dependencies (#222). - CI with OSS-Fuzz for the deprecated `actions/upload-artifact@v3` (#221). - Bug where the `radix` feature wasn't enabling `power-of-two` in `lexical-core` or `lexical` (#204). - Fixed performance issues due to a lack of inlining on the Eisel-Lemire algorithm (#210). diff --git a/scripts/docs.py b/scripts/docs.py index 08bbe9eb..be1d932b 100644 --- a/scripts/docs.py +++ b/scripts/docs.py @@ -159,8 +159,9 @@ async def validate_links() -> None: if 'SKIP_LINKS' not in os.environ: parser.feed(path.name, data) if 'SKIP_TODO' not in os.environ: - if 'TODO' in data: - raise ValueError(f'Found TODO in documentation for file "{path.name}".') + relative = path.relative_to(target_dir) + if 'TODO' in data and 'lexical-' in str(relative.parent): + raise ValueError(f'Found TODO in documentation for file with path "{relative}".') # deduplicate and validate all our links if 'SKIP_LINKS' not in os.environ: