docs(api): refine public API docs + test title cleanup#5
Merged
Conversation
- evaluation_context: clarify prefixes, bool/list helpers, lifecycle - function_factory: extension guidance, registry usage, comparators - fuzzy_boolean: certainty semantics and compact storage - parser_options: config guidance, validator, case sensitivity - supported_prefixes: design tips and performance notes - token: invariants, TokenTypes reference, hasError intent - tokeniser: comments/keywords, unparse notes, char classes - semantic_exception: deterministic, actionable messages with token context - boolean_expression_analyser: grammar/precedence and extension points - semantic_analyser: responsibilities, rule syntax, comments treatment - boolean_interpreter: evaluation order and ruleState writeback
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
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.
This PR refines developer‑focused documentation across the public API and tidies test titles for coherence.
Summary
Public API docs: clearer guidance and practical tips
Tests: rename a few unclear titles and trim comments
Validation
npx baldrick-broth@latest test unit: formatting, coverage, example run, and unit tests all passed.Notes