Skip to content

docs: document updating multiple fields with custom shadow variables - #2619

Open
TomCools wants to merge 2 commits into
TimefoldAI:mainfrom
TomCools:docs/2472
Open

docs: document updating multiple fields with custom shadow variables#2619
TomCools wants to merge 2 commits into
TimefoldAI:mainfrom
TomCools:docs/2472

Conversation

@TomCools

Copy link
Copy Markdown
Contributor

Solves #2472

document how to update multiple fields with a custom shadow variable.

@TomCools
TomCools requested a review from triceo as a code owner August 26, 2026 21:21
Copilot AI lite review requested due to automatic review settings August 26, 2026 21:21
@TomCools
TomCools requested a review from rsynek as a code owner August 26, 2026 21:21
@TomCools TomCools added the component/docs Improvements or additions to documentation label Aug 26, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the domain-modeling documentation to explain how to update multiple related pieces of declarative shadow state by grouping them into a single wrapper (e.g., a Java record) and exposing the individual values via accessors, addressing #2472.

Changes:

  • Added a new documentation section describing the “wrapper object” approach for computing multiple related shadow values together.
  • Included a Java example using a JobState record as the single shadow variable value.
  • Adjusted several nearby section titles to sentence case (“… shadow variables”).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

private JobState jobState;

@ShadowSources("previous.jobState")
private JobState jobStateSupplier() {

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread docs/src/modules/ROOT/pages/domain-modeling/modeling-planning-problems.adoc Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment on lines +2031 to +2032
@ShadowSources("previous.jobState")
private JobState jobStateSupplier() {
@triceo

triceo commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

@Christopher-Chianelli Please take a look.

@triceo triceo added this to the v2.7.0-rc-1 milestone Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants