docs(profile): qualify Geoconnex bundling as feature-gated#3917
Merged
Conversation
…2573) Roborev #2573 (Low): the bundled-profiles list claimed Geoconnex was embedded unconditionally, but the geoconnex profile is only compiled in when the `geoconnex` cargo feature is enabled — builds without it (notably qsvlite / qsvmcp, and qsvdp unless built with `-F datapusher_plus,geoconnex`) cannot accept `--profile geoconnex`. Updated README.md (the source of truth) to read "...DCAT-AP v3 and Croissant 1.1 bundled; Geoconnex when built with the `geoconnex` feature" and ran `qsv --generate-help-md` to regenerate the auto- generated `docs/help/TableOfContents.md` and `docs/help/profile.md` counterparts. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
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
Follow-up to commit
27cf47441(PR-less doc commit on master). The bundled-profiles list in theprofilecommand description claimed Geoconnex was embedded unconditionally, but thegeoconnexprofile is only compiled in when thegeoconnexcargo feature is enabled. Builds without it (notablyqsvliteandqsvmcp, andqsvdpunless built with-F datapusher_plus,geoconnex) cannot accept--profile geoconnex.This PR closes the doc/reality gap in three files and uses the help generator so they stay in sync.
Changes
README.md(single source of truth): reworded the profile row from "...Croissant 1.1 and Geoconnex profiles bundled" to "...Croissant 1.1 bundled; Geoconnex when built with thegeoconnexfeature".docs/help/TableOfContents.mdanddocs/help/profile.md: regenerated viaqsv --generate-help-md(per CLAUDE.md, these files must never be hand-edited — the generator reads the README command table).Roborev
Closes local roborev review #2573 (Low). The reviewer flagged this exact discrepancy and suggested the wording adopted here.
Test plan
cargo build --bin qsv -F all_features— cleanqsv --generate-help-md— generator regenerated docs/help/TableOfContents.md and docs/help/profile.md from the updated README.md rowgeoconnexfeature")🤖 Generated with Claude Code