Docs migration guide breaking changes#309
Merged
Merged
Conversation
Closes #159. plcc-parse's dropped -t/OK output and plcc-scan's new output format were only mentioned in a comparison table, causing confusion for instructors migrating workshop materials.
…or changes), update roadmap
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a prominent “Breaking behavior changes” callout to the migration guide so instructors migrating existing PLCC materials don’t miss key CLI/output differences.
Changes:
- Add a “Breaking behavior changes” section to
docs/migration.mddescribingplcc-parseandplcc-scanoutput/behavior differences. - Record and close the corresponding dev-docs issue (#159) documenting the motivation for the callout.
- Increment
dev-docs/issues/.next-id.txtto the next available issue ID.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/migration.md | Adds an upfront callout section highlighting two easy-to-miss breaking behavior/output changes. |
| dev-docs/issues/done/159-migration-guide-missing-breaking-changes-callout.md | Adds a closed issue documenting why the migration guide needed a breaking-changes callout. |
| dev-docs/issues/.next-id.txt | Advances the issue ID counter after introducing issue #159. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+10
| These two command-output changes are easy to miss in the checklist below and | ||
| have caught instructors migrating workshop materials by surprise. |
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.
The authors of this PR...