docs: link worked examples from doc.go - #117
Merged
Merged
Conversation
Add a "Worked Examples" pointer section to doc.go that names each narrated test with a one-line description so pkg.go.dev readers can find the runnable templates. Mirrors how the existing Examples section introduces each pattern with a snippet, but for tests that are too long to inline. Tests linked: - TestExampleActivateTestdummy (BIP9 ACTIVE path on Core) - TestExampleTimeoutWithoutLockin (BIP9 FAILED path via WarpTime) - TestExampleActivateBIP119 (Inquisition skip-when-missing template) - TestVariantDetection (Core/Inquisition smoke test) - TestExampleReorg (two-node fork resolution) No code changes; ai-check green. Co-Authored-By: Claude Opus 4.7 (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.
Summary
Pure docs follow-up to Phase 6. Adds a "Worked Examples" pointer section to
doc.gothat names each narrated test with a one-line description, so pkg.go.dev readers can find the runnable templates.Tests linked:
TestExampleActivateTestdummy(BIP9 ACTIVE path on Core)TestExampleTimeoutWithoutLockin(BIP9 FAILED path viaWarpTime)TestExampleActivateBIP119(Inquisition skip-when-missing template)TestVariantDetection(Core/Inquisition smoke test)TestExampleReorg(two-node fork resolution)No code changes.
Test plan
make ai-checkgreen.go doc github.com/neverDefined/go-regtestshows the new section before "Soft-fork Testing".🤖 Generated with Claude Code