Skip to content

Commit

Permalink
Merge pull request #222 from Alexhuszagh/docs_todo
Browse files Browse the repository at this point in the history
Add patches for dependencies with TODOs in the docs.
  • Loading branch information
Alexhuszagh authored Feb 6, 2025
2 parents 6c8d96b + af7fff2 commit 0d9e161
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
5 changes: 3 additions & 2 deletions scripts/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 0d9e161

Please sign in to comment.