chore: deprecate the chained variable #2017
Open
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR deprecates chained planning variables in preparation for their removal in Timefold Solver 2.0, directing users to use list variables instead.
Changes:
- Added deprecation notices to documentation sections about chained variables
- Added
@Deprecatedannotations to all chained variable-related classes and configuration types - Removed outdated documentation note about when to use chained variables over list variables
- Added upgrade guide entry for version 1.31.0 explaining the deprecation
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| modeling-planning-problems.adoc | Removed note comparing chained vs list variables; added deprecation notices to chained variable sections |
| upgrade-to-latest-version.adoc | Added 1.31.0 upgrade note documenting chained variable deprecation |
| responding-to-change.adoc | Updated PinningFilter deprecation message to specify removal in version 2.0 |
| enterprise-edition.adoc | Added deprecation notice to nearby selection with chained variable section |
| score-calculation.adoc | Updated constraint streams legacy methods deprecation message; removed deprecated constraint package note |
| constraint-configuration.adoc | Updated constraint packages deprecation to specify removal in version 2.0 |
| TailChainSwapMoveSelectorFactory.java | Added @Deprecated annotation and JavaDoc |
| TailChainSwapMoveSelector.java | Added @Deprecated annotation and JavaDoc |
| TailChainSwapMove.java | Added @Deprecated annotation and JavaDoc |
| SubChainSwapMoveSelectorFactory.java | Added @Deprecated annotation and JavaDoc |
| SubChainSwapMoveSelector.java | Added @Deprecated annotation and JavaDoc |
| SubChainSwapMove.java | Added @Deprecated annotation and JavaDoc |
| SubChainReversingSwapMove.java | Added @Deprecated annotation and JavaDoc |
| SubChainReversingChangeMove.java | Added @Deprecated annotation and JavaDoc; removed unused import |
| SubChainChangeMoveSelectorFactory.java | Added @Deprecated annotation and JavaDoc |
| SubChainChangeMoveSelector.java | Added @Deprecated annotation and JavaDoc |
| SubChainChangeMove.java | Added @Deprecated annotation and JavaDoc; removed unused import |
| KOptMoveSelectorFactory.java | Added @Deprecated annotation and JavaDoc |
| KOptMoveSelector.java | Added @Deprecated annotation and JavaDoc |
| KOptMove.java | Added @Deprecated annotation and JavaDoc |
| ChainedSwapMove.java | Added @Deprecated annotation and JavaDoc |
| ChainedChangeMove.java | Added @Deprecated annotation and JavaDoc |
| package-info.java | Added @Deprecated annotation and JavaDoc to entire package |
| TailChainSwapMoveSelectorConfig.java | Added @Deprecated annotation and JavaDoc |
| SubChainSwapMoveSelectorConfig.java | Added @Deprecated annotation and JavaDoc |
| SubChainChangeMoveSelectorConfig.java | Added @Deprecated annotation and JavaDoc |
| KOptMoveSelectorConfig.java | Added @Deprecated annotation and JavaDoc |
| PlanningVariableGraphType.java | Added @Deprecated annotation and JavaDoc to enum |
| PlanningVariable.java | Added @Deprecated annotation and JavaDoc to graphType() method |
| AnchorShadowVariable.java | Added @Deprecated annotation and JavaDoc |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.