Skip to content

Conversation

@andy-stark-redis
Copy link
Contributor

Notebooks for the sets data type page, along with a few improvements to the notebook conversion script.

- Created config.py: Configuration and kernel spec management
- Created validator.py: Input validation and language detection
- Created parser.py: File parsing with marker detection
- Created unwrapper.py: Code unwrapping logic
- Created notebook_builder.py: Notebook creation and cell generation
- Simplified jupyterize.py: Main orchestrator (696 → 142 lines)
- Updated test_jupyterize.py: New module imports
- Updated SPECIFICATION.md: Added implementation lessons learned

Benefits:
- 80% reduction in main script size
- Clear separation of concerns
- Each module independently testable
- Easier to maintain and extend
- All 25+ tests pass
- Backward compatible

Module sizes:
- config.py: ~120 lines
- validator.py: ~95 lines
- parser.py: ~180 lines
- unwrapper.py: ~180 lines
- notebook_builder.py: ~160 lines
- jupyterize.py: ~142 lines (was 696)

Total: ~877 lines (vs 843 original) with much better organization
@andy-stark-redis andy-stark-redis requested a review from a team December 16, 2025 11:06
@andy-stark-redis andy-stark-redis self-assigned this Dec 16, 2025
@andy-stark-redis andy-stark-redis added the clients Client library docs label Dec 16, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 16, 2025

DOC-6100

@github-actions
Copy link
Contributor

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (quick scan).

@andy-stark-redis
Copy link
Contributor Author

Thanks @dwdougherty !

@andy-stark-redis andy-stark-redis merged commit 7400d35 into main Dec 16, 2025
8 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6100-set-dt-notebooks branch December 16, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants