docs(agc): correct by-species index help text#30
Merged
Conversation
The download command described the by-species index as a live OSF crawl in both its long help and the --agc-index flag, but loadAGCIndex now downloads the node's published index by default and only crawls as a fallback. Update both strings and regenerate the CLI reference. Add a help-text test asserting the published-index default so the wording cannot silently drift back.
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.
What
Corrects the
atb agc downloadhelp text, which still described the by-speciesindex as a live OSF crawl. Since the hosted-index work (
3dd7b9a,9776742),loadAGCIndexdownloads the node's published index by default and only crawlsas a fallback. Two strings had drifted:
either crawled from the OSF node and cached)--agc-indexflag default (crawl the OSF node and cache it)Both now describe the published-index-first default, and the generated CLI
reference (
docs/reference/cli/atb_agc_download.md) is regenerated to match.This is the code-side follow-up to the guide fix in #29 (which corrected the
hand-written
guides/agc.md). Together they bring every AGC by-species docsurface in line with the code.
Test
Adds
TestAGCDownloadHelpAgcIndexDefault: asserts--helpadvertises thepublished-index default and no longer claims the crawl-only default. Written
test-first - it failed on the old strings and passes on the new ones.
Validation
go build ./...andgo vet ./internal/cli/cleango test ./internal/cli/passesmake docsis idempotent, so the docs staleness gate stays greenmkdocs build --strictpassesScope
Help text and the regenerated reference only. No behavior change - both edits
are string literals with no call-graph impact.