Repository navigation
Bring the documentation in line with the code, and fix what it found (B506-B519) - #28
Merged
Merged
Conversation
A whole-repository pass over Documentation/, the READMEs, BUILDING.md, RELEASING.md, the project CLAUDE.md files and the skills, with the code taken as correct. - User pages: settings labels, defaults and dialog sections (the Undeclared rule's tool checkboxes and the package.order switch under their rules), CLI options, exit codes and JSON fields, MCP tool arguments, toolbar and dialog labels, and the gaps where a visible feature had no page - Contributor docs and skills: paths, types, scripts, CI jobs and package lists that had drifted, and example names that were real commercial products - Screenshots regenerated; a new settings-reference-8 shows the Undeclared rule with its tool checkboxes; dependency-analysis-3 now clicks the node Cytoscape reports, since a hover never highlighted it Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The pass corrected the docs to say what the code does; these are the places where the code may be what is wrong, or a decision is needed. Each is a row under Known open issues with its fix, and the next id moves to B520. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- B506: a load that changes which libraries are loaded marks the MCP session's dependency and resource analysis as not run, so a replaced copy or a library added later no longer leaves stale edges - B507: -h/--help after any mlqt command prints the usage and exits 0 - B508: hook resolves a relative --dependency against the current directory, as check and baseline do - B509: the --help text gives the real --config default and lists --allow-version-mismatch for baseline - B510: the unreachable Add to Dictionary button is gone from the Finding Details dialog; the right-click menu is the spelling workflow - B511: ModelAnalyzer derives from ExternalResourceExtractor instead of carrying a copy of its rules, held by a parity test over every extractor case - B512: DiagramNode's default colours are theme variables Cytoscape can paint - B513: mlqt_session status reports each library's origin - B514: mlqt_edit_class's description names every field it accepts - B515: the vendor licence attribution stays, by decision - B516: the stale DymolaInterface test overview is retired for the README - B517: ModelicaGraph no longer references RevisionControl, which it never used - B518: the Dymola eval scenario file has a generic name - B519: run-all-tests.ps1 says CI runs nine suites Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…sistency-pass # Conflicts: # ModelicaParser/PublicAPI.Unshipped.txt
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.
A whole-repository documentation pass, with the code taken as correct, and fixes for what it found in the code.
Documentation (0ad7f74)
Documentation/):MLQT.Cli.settings-reference-8shows the Undeclared rule with its tool checkboxes.dependency-analysis-3now clicks the node; a hover never highlighted it.Code (B506–B519, 40ba6e9)
-h/--helpafter anymlqtcommand prints the usage and exits 0hookresolves a relative--dependencyagainst the current directory, ascheckandbaselinedo--helptext: real--configdefault;--allow-version-mismatchlisted forbaselineModelAnalyzerderives fromExternalResourceExtractorinstead of copying its rules; a parity test runs every extractor case through bothDiagramNodedefault colours are theme variables Cytoscape can paintmlqt_session statusreports each library'soriginmlqt_edit_classdescription names every field it acceptsModelicaGraphno longer referencesRevisionControl, which it never usedrun-all-tests.ps1comment: CI runs nine suitesPublic API:
ModelicaParseraddsExternalResourceExtractor.IsLoadResourceCall.ModelAnalyzer.ResourcesandVisitCompositionare now inherited from the extractor; source that uses them still compiles.ModelicaGraphfrom source no longer getRevisionControlthrough it. A consumer that relied on that needs its own reference.Verification
build/run-all-tests.ps1 -CoreOnly: all 9 suites pass (9,568 tests).CI=true dotnet build MLQT.slnx -c Release: 0 warnings.build/check-coverage.ps1: gate passed.🤖 Generated with Claude Code