docs: reconstruct examples for full godoc coverage; fix stale package doc - #21
Merged
Conversation
… doc - doc.go: the package comment described the pre-explicit-model design (a /*> */ partial include, "drops clauses that become empty and AND/OR left dangling"). Rewrite it to describe the current explicit model and @include. - example_test.go: rebuilt from scratch as 26 testable examples. Package-level examples (Example, Example_conditional, Example_iteration, Example_literal, Example_inListExpansion, Example_arrayBind, Example_include, Example_dialects) cover the README's concepts and render in the package's top Examples section; the rest are attached to their public symbol (ExampleParse, ExampleParseFile, ExampleExpand, ExampleExpandFile, ExampleNewParser, ExampleWithDialect, ExampleWithLoader, ExampleWithStackedLoader, ExampleWithEvaluator, the loader constructors, ExampleParser_Parse/_ParseFile, ExampleTemplate_Build, ExampleRegistryLoader_Register, ExampleStatement_SQLWithArgs). Each statement-building example prints SQL, Args, and the values-embedded SQLWithArgs form. Fixes the old lowercase ExampleStatement_sqlWithArgs (now attaches to the method page). - bench_test.go: remove the micro-benchmark (not run in CI, stale schema); keep its concurrency/immutability check, moved to bisql_test.go as TestTemplateConcurrentBuild (run under -race). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YAydPGeSHjZvJv22oz4P6d
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #21 +/- ##
=======================================
Coverage 96.52% 96.52%
=======================================
Files 11 11
Lines 951 951
=======================================
Hits 918 918
Misses 21 21
Partials 12 12 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Reconstructs the godoc examples and fixes an outdated package comment.
/*> */partial include, "drops clauses that become empty and AND/OR left dangling"). Rewritten to describe the current explicit model and@include.Example,Example_conditional,Example_iteration,Example_literal,Example_inListExpansion,Example_arrayBind,Example_include,Example_dialects) cover the README concepts and render in the package's top Examples section; the rest attach to their public symbol so they render under it (ExampleParse,ExampleParseFile,ExampleExpand,ExampleExpandFile,ExampleNewParser,ExampleWithDialect,ExampleWithLoader,ExampleWithStackedLoader,ExampleWithEvaluator, the loader constructors,ExampleParser_Parse/_ParseFile,ExampleTemplate_Build,ExampleRegistryLoader_Register,ExampleStatement_SQLWithArgs). Each statement-building example prints SQL, Args, and the values-embeddedSQLWithArgsform. Fixes the old lowercaseExampleStatement_sqlWithArgs(now attaches to the method page).employeesschema); keep its concurrency/immutability check, moved tobisql_test.goasTestTemplateConcurrentBuild(run under-race).🤖 Generated with Claude Code