docs: mark unsupported partitioning shapes as out of scope (not future PR)#57
Merged
Merged
Conversation
…e PR) The remaining "split / merge / reorder", strategy / expression change, and first-time / REMOVE PARTITIONING shapes have been sitting on the floor since v1 with the doc framing implying they'd land in some future PR. They aren't planned. Re-frame them as permanent out-of-scope items the operator manages by hand, and drop the TODO.md entry that was tracking them. TODO.md: - Removed the partition entry. With nothing else under "Medium — object coverage", the section header goes too. PARTITIONING.md "Diffs that still error — manage by hand": - "Strategy / expression change": "Future PR." → "out of scope for myschema". - "Adding or removing partitioning entirely": "Both directions are future work" → "Both directions are out of scope for myschema". The embedded error-message quotes (`is not yet generated by myschema`) are kept verbatim because they reflect what the operator literally sees on stderr; added a short caveat that the wording is historical and there is no roadmap PR. The matching error strings in `diff/partitions.go` (3 sites) still say "is not yet generated by myschema" — those weren't touched in this commit since the existing fixtures pin the exact text. Updating the wording would be a follow-up that also rewrites two fixtures and a couple of code comments.
There was a problem hiding this comment.
Pull request overview
Re-frames unsupported partitioning diff shapes as permanently out of scope (manual operator workflow), removing “future PR” language and pruning the TODO tracker accordingly.
Changes:
- Remove the TODO entry tracking “partition diff generation beyond supported shapes”.
- Update PARTITIONING.md to mark strategy/expression changes and add/remove partitioning as out of scope, with a historical-note caveat about current error wording.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| TODO.md | Removes the medium-priority TODO item about unsupported partition diff shapes. |
| PARTITIONING.md | Updates “Diffs that still error” sections to state certain partitioning changes are out of scope, and adds clarifying caveats. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #57 +/- ##
=======================================
Coverage 71.16% 71.16%
=======================================
Files 28 28
Lines 3062 3062
=======================================
Hits 2179 2179
Misses 647 647
Partials 236 236 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Both inline review comments flagged the same Markdown issue: backticked error strings split across newlines won't render as inline code. Two affected blocks in PARTITIONING.md "Diffs that still error": - "Strategy / expression change": the `partition strategy / expression differs` error string was wrapped at the slash. - "Adding or removing partitioning entirely": the two `first-time ALTER TABLE … PARTITION BY … is not yet generated by myschema` and `ALTER TABLE … REMOVE PARTITIONING is not yet generated by myschema` error strings were both wrapped mid-string. Restructured the surrounding prose so each backticked error string sits on its own line (long enough to overflow the 80-col convention, but the inline-code rendering needs it that way). The actual error wording is unchanged.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Singular "error message" → plural to agree with the two distinct errors enumerated immediately below. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 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
The remaining unsupported partitioning shapes — split / merge / reorder, strategy / expression change, first-time
PARTITION BY,REMOVE PARTITIONING— have been on the floor since v1 with the doc framing implying they would land in some future PR. They aren't planned. Re-frame them as permanent out-of-scope items the operator manages by hand, and drop theTODO.mdentry that was tracking them.No code change. No behaviour change. Doc-only.
TODO.md
**Partition diff generation beyond the supported shapes**entry. With nothing else under## Medium — object coverage, the section header goes too.PARTITIONING.md "Diffs that still error — manage by hand"
Future PR.→out of scope for myschema.Both directions are future work→Both directions are out of scope for myschema. The embedded error-message quotes (is not yet generated by myschema) are kept verbatim because they reflect what the operator literally sees on stderr; added a short caveat that the wording is historical and there is no roadmap PR.Follow-up not in this PR
The matching error strings in
diff/partitions.go(3 sites) still sayis not yet generated by myschema. Updating that wording tois out of scope for myschemawould be a separate change that also touches:testdata/plan/partition_remove_partitioning_errors.yml(pinned error string)testdata/plan/partition_add_partitioning_errors.yml(pinned error string)// future PRcomments indiff/partitions.goSkipped from this PR to keep the scope cleanly doc-only.
Test plan
make lintmake test(8.0)