feat(lib): intentional public API surface with a semver-tracked prelude#131
Merged
Conversation
src/lib.rs re-exported whole internal modules with no curated surface or stability contract. Add crate-level API docs (getting-started example that doubles as a doctest), a semver-tracked `prelude` module re-exporting the core stable types (AppConfig, AppResults, run_calculation[_checked], results_display_document, WireCalculation, TransformerRatio, GroundClass, ImpedanceClass, the optimizer config/result types, Band/BandType/ITURegion), and explicit stability notes distinguishing the stable API from advanced-use modules and private implementation details. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Backlog T5.
src/lib.rsre-exported whole internal modules with no curated public surface or stability contract (project-review finding).preludemodule re-exporting the stable core:AppConfig,AppResults,AppRequest/AppResponse,AppError,CalcMode,run_calculation[_checked],results_display_document,ResultsDisplayDocument;WireCalculation,TransformerRatio,GroundClass,ImpedanceClass, the optimizer config/result types;Band/BandType/ITURegion.app/bands/calculations/prefs/sessionspublic for advanced use;tuifor embedding; CLI/export/NEC/fnec are private.Non-breaking (additive).
cargo testall pass incl. the new doctest; clippy + fmt clean.🤖 Generated with Claude Code
https://claude.ai/code/session_01Jf8uBU8AYxkrG8fa8yo6tC