Document missing command error codes - #4697
Merged
Merged
Conversation
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
E015_FS_CASE_PROBE_FAILED,E016_CHECKPOINT_NOT_FOUND, andE017_WORKSPACE_MANIFEST_INVALIDin both USER_GUIDE error-code tablesCommandErrorCodeschangelog.d/unreleased/4644.docs.mdWhy
The stable command error-code taxonomy already defined E015–E017, but the English and Japanese USER_GUIDE tables skipped directly from E014 to E018. This left scripts, AI agents, and users without a complete reference.
Impact
The user guide now exposes the complete stable error-code sequence in English and Japanese. Future additions or removals from
CommandErrorCodeswill fail the documentation drift test unless both tables are updated in the same change.Validation
dotnet test tests/CodeIndex.Tests/CodeIndex.Tests.csproj --no-restore --filter FullyQualifiedName~CodeIndex.Tests.DocumentationDriftTestsdotnet run --project tools/CodeIndex.Changelog -- checkdotnet format CodeIndex.sln --verify-no-changes --no-restoredotnet build CodeIndex.sln -c Release --no-restore -p:UseSharedCompilation=falsedotnet ./src/CodeIndex/bin/Debug/net8.0/cdidx.dll status --check --jsonorigin/main..HEAD: no blocking/actionable issues foundAn additional full-solution test run was stopped after 22 minutes while sandbox-conditioned tests continued to be skipped; no failures were reported before cancellation. The focused documentation drift suite passed on both net8.0 and net9.0.
Documentation and changelog
USER_GUIDE.mdin both English and Japanese sectionschangelog.d/unreleased/4644.docs.mdFollow-up candidates
None.
Fixes #4644