docs: document integration search/info/scaffold subcommands (#3174)#3194
Open
Noor-ul-ain001 wants to merge 3 commits into
Open
docs: document integration search/info/scaffold subcommands (#3174)#3194Noor-ul-ain001 wants to merge 3 commits into
search/info/scaffold subcommands (#3174)#3194Noor-ul-ain001 wants to merge 3 commits into
Conversation
) docs/reference/integrations.md omitted three subcommands that exist in code, breaking parity with the extension/preset/bundle/workflow references which all document their search/info equivalents. Added sections for: - `specify integration search [query]` (--tag, --author) - `specify integration info <integration_id>` - `specify integration scaffold <key>` (--type: markdown/skills/toml/yaml) Content mirrors the command docstrings, arguments, and options in src/specify_cli/integrations/_query_commands.py and _scaffold_commands.py. Fixes github#3174. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the integration CLI reference documentation to include the previously undocumented specify integration search, specify integration info, and specify integration scaffold subcommands, restoring parity with other reference docs (extensions/presets/bundles/workflows).
Changes:
- Documented
specify integration search [query]with--tag/--authorfilters. - Documented
specify integration info <integration_id>usage. - Documented
specify integration scaffold <key>and the supported--typevalues.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/integrations.md | Adds reference sections for integration search, integration info, and integration scaffold. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
@mnriem requested changes has been implemented. |
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.
What
docs/reference/integrations.mddocumented theintegrationcommands but omitted three subcommands that exist in code. This broke parity with theextension,preset,bundle, andworkflowreferences, all of which document theirsearch/infoequivalents.Fixes #3174.
Missing commands now documented
specify integration search [query](--tag,--author)src/specify_cli/integrations/_query_commands.pyspecify integration info <integration_id>src/specify_cli/integrations/_query_commands.pyspecify integration scaffold <key>(--type)src/specify_cli/integrations/_scaffold_commands.pyHow
Added three sections matching the structure used for the analogous extension/preset/bundle references:
All option names, the kebab-case key requirement, and the scaffold
--typevalues (markdowndefault, plusskills,toml,yaml) were taken directly from the command definitions and docstrings in the source, so the docs match runtime behavior.🤖 Generated with Claude Code