Fix documentation inconsistency in sub-models example #132
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
Co-authored-by: jaccz <9115223+jaccz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Documentation on sub-models
Fix documentation inconsistency in sub-models example
May 19, 2025
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.
This PR fixes the inconsistency in the sub-models documentation where the example showed a sub-model with order 2 (
{ PLATFORM, CPUS, RAM, HDD } @ 2), but the explanation and diagram that followed referenced using PICT with order 3 (/o:3).The inconsistency made the documentation confusing and could lead readers to misunderstand how sub-models function, as noted in issue #95.
Changes made:
/o:3in the explanation to/o:2to match the exampleorder = 2instead oforder = 3/o:2(approximately 40 test cases with sub-model vs. 17 without)These changes make the documentation consistent and clearer for readers to understand the impact of using sub-models with PICT.
Fixes #95.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.