Conversation
- Add naming conventions to modules.md: symbol (public), _symbol (private helper), __symbol (default value) - Rename private functions in Descriptions: compute_similarity → _compute_similarity, find_similar_descriptions → _find_similar_descriptions, format_description_candidates → _format_description_candidates - Rename private functions in Exceptions: extract_user_frames → _extract_user_frames, format_user_friendly_error → _format_user_friendly_error, ansi_color → _ansi_color, ansi_reset → _ansi_reset, print_ansi_styled → _print_ansi_styled - Update planning.md with improved checkpoint templates (MCP preferred, fallback commands) - Fix extension tests to use fake types per testing-creation.md §6 (prevents flaky tests when extensions are loaded elsewhere)
…ethods - Add naming conventions to modules.md: symbol (public), _symbol (private helper), __symbol (default value) - Rename private functions in Descriptions: compute_similarity → _compute_similarity, find_similar_descriptions → _find_similar_descriptions, format_description_candidates → _format_description_candidates - Rename private functions in Exceptions: extract_user_frames → _extract_user_frames, format_user_friendly_error → _format_user_friendly_error, ansi_color → _ansi_color, ansi_reset → _ansi_reset, print_ansi_styled → _print_ansi_styled - Update planning.md with improved checkpoint templates (MCP preferred, fallback commands) - Fix extension tests to use fake types per testing-creation.md §6 (prevents flaky tests when extensions are loaded elsewhere)
… philosophy - Move extensions from ext/*.jl to ext/ExtensionName/ subdirectories with proper entry_point.jl pattern - Move extension implementations to src/Extensions/ submodules (coverage_postprocessing.jl, documenter_reference.jl, test_runner.jl) - Split Unicode module into subscripts.jl and superscripts.jl submodules - Update all imports to use qualified paths (CTBase.Extensions.run_tests, Unicode.ctindices, etc.) - Update documentation to reflect new qualified import paths - Restructure test files to follow new module organization - Remove redundant test files (test_utils.jl, test_display.jl) and consolidate into enriched test files
- Move extensions from ext/*.jl to ext/ExtensionName/ subdirectories with proper entry_point.jl pattern - Move extension implementations to src/Extensions/ submodules (coverage_postprocessing.jl, documenter_reference.jl, test_runner.jl) - Split Unicode module into subscripts.jl and superscripts.jl submodules - Update all imports to use qualified paths (CTBase.Extensions.run_tests, Unicode.ctindices, etc.) - Update documentation to reflect new qualified import paths - Restructure test files to follow new module organization - Remove redundant test files (test_utils.jl, test_display.jl) and consolidate into enriched test files
- docs/api_reference.jl: Add all missing source files to each module's documentation (Core, Unicode, Extensions, and all extensions) - docs/src/guide/test-runner.md: Remove invalid @ref to TestRunner.TestRunInfo (not accessible in documentation context) - ext/TestRunner/entry_point.jl: Remove invalid @ref to TestRunner.TestRunInfo from docstring - src/Core: Rename utils.jl to default.jl for clarity
Split large monolithic test files into smaller, focused test files: - Core: test_core.jl → test_core_types.jl, test_utils.jl - Exceptions: test_types.jl → test_exception_types.jl, test_extension_error.jl - Extensions: test_extensions_enriched.jl → test_extension_stubs.jl - Extensions: test_coverage_edge_cases.jl → test_coverage_helpers.jl - Extensions: test_documenter_reference.jl → 7 focused files (api, config_helpers, page_building, pipeline, symbol_helpers, type_formatting, types) - Extensions: test_testrunner.jl → 6 focused files (arg_parsing, execution, progress, selection, types) - Unicode: test_unicode_enriched.jl, test_unicode_utils.jl → test_subscripts.jl, test_superscripts.jl Enhanced exception display tests with new branches for IncorrectArgument and AmbiguousDescription. Added Descriptions import to test_display_description.jl.
Refactor test suite for orthogonality
Member
Author
Status UpdateProgress on the planned features:
The |
…gative vs multi-digit values - Split error condition in ctindice(): i < 0 now shows "must be positive" (expected: ≥ 0), i > 9 shows "must be a single digit" with suggestion to use ctindices() - Split error condition in ctupperscript(): same pattern with ctupperscripts() suggestion - Updated tests to verify new error messages - All 90 tests in test/suite/unicode/ pass
5 tasks
- Refactored display.jl to use modular rendering functions - Added structured exception context display with sections - Improved error message formatting with clear hierarchy - Updated tests to cover new display behavior - Updated documentation in exceptions.md and index.md
…edesign Redesign exception display with improved formatting and structure
…eview Review and improve exception presentation
Member
Author
|
Scope update: Parts 2, 6, and 7 from the planned features are postponed to a later date. Part 3 (Abstract types module) is cancelled. The current focus remains on the completed items (1, 4, and 5) and the DeepWiki integration. |
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.
Overview
This PR introduces the first step of a larger refactoring plan for CTBase.jl. The current change adds a DeepWiki badge to the documentation landing page with an appropriate disclaimer about AI-generated content.
Development Strategy
This PR establishes a
developbranch that will serve as the integration point for multiple feature branches. Each feature will be developed in its own branch and merged intodevelop, following this workflow:Planned Features
The following features will be developed in separate branches and merged into
develop:DeepWiki integration ✓ (this PR)
Traits module
Abstract types module
Private/public method naming and distribution ✓
Exception presentation ✓
showmethods for exceptionsctindice(-1))JLDocTest integration
jldoctestfunctionalityVitePress documentation
Current Changes
docs/src/index.mdTesting
Documentation builds successfully with
julia --project=. docs/make.jl.