Skip to content

Commit 0d9e161

Browse files
authored
Merge pull request #222 from Alexhuszagh/docs_todo
Add patches for dependencies with TODOs in the docs.
2 parents 6c8d96b + af7fff2 commit 0d9e161

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

CHANGELOG

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2929

3030
### Fixed
3131

32+
- Patch doctests with TODOs in dependencies (#222).
3233
- CI with OSS-Fuzz for the deprecated `actions/upload-artifact@v3` (#221).
3334
- Bug where the `radix` feature wasn't enabling `power-of-two` in `lexical-core` or `lexical` (#204).
3435
- Fixed performance issues due to a lack of inlining on the Eisel-Lemire algorithm (#210).

scripts/docs.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,9 @@ async def validate_links() -> None:
159159
if 'SKIP_LINKS' not in os.environ:
160160
parser.feed(path.name, data)
161161
if 'SKIP_TODO' not in os.environ:
162-
if 'TODO' in data:
163-
raise ValueError(f'Found TODO in documentation for file "{path.name}".')
162+
relative = path.relative_to(target_dir)
163+
if 'TODO' in data and 'lexical-' in str(relative.parent):
164+
raise ValueError(f'Found TODO in documentation for file with path "{relative}".')
164165

165166
# deduplicate and validate all our links
166167
if 'SKIP_LINKS' not in os.environ:

0 commit comments

Comments
 (0)