Merged
Conversation
|
✅ All checks passed! Ready for review. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects fabricated documentation by removing non-existent features and replacing them with accurate information about the wrapper's actual functionality. The changes align the documentation with the source code in src/capiscio/cli.py and src/capiscio/manager.py.
Key Changes
- Removed fictional
CAPISCIO_CORE_PATHenvironment variable that doesn't exist in the source code - Removed fictional
capiscio scorecommand, replacing it with the actualcapiscio validate --jsonsyntax - Added documentation for the actual wrapper-specific flags (
--wrapper-versionand--wrapper-clean)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
README.md |
Replaced fabricated capiscio score command with accurate capiscio validate --json command |
docs/index.md |
Added clarification that this is a wrapper package with no validation logic, enhanced Quick Start section with accurate examples |
docs/reference/commands.md |
Removed fabricated CAPISCIO_CORE_PATH environment variable, added accurate documentation for core commands with proper examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
This PR removes fabricated documentation that didn't match the actual source code.
What Was Wrong
The docs previously mentioned:
CAPISCIO_CORE_PATHenvironment variable - This does NOT exist in the source codecapiscio scorecommand - This command does NOT existThese were hallucinated by the documentation generator and don't reflect actual functionality.
Changes
Removed Fabricated Content
docs/reference/commands.md- Removed fakeCAPISCIO_CORE_PATHenv varREADME.md- Removed fakecapiscio scorecommand exampleAdded Accurate Content
--wrapper-versionand--wrapper-cleanVerification
Verified against actual source code in
capiscio_python/cli.py:--wrapper-versionexists--wrapper-cleanexistsCAPISCIO_CORE_PATHdoes NOT existcapiscio scoredoes NOT existFiles Changed
README.md- Removed fake score commanddocs/index.md- Updated wrapper descriptiondocs/reference/commands.md- Removed fake env var, added real wrapper flags