Skip to content

Add missing documentation#740

Open
empeje wants to merge 3 commits intoapache:mainfrom
empeje:empeje/add-documentation-on-execution-plan
Open

Add missing documentation#740
empeje wants to merge 3 commits intoapache:mainfrom
empeje:empeje/add-documentation-on-execution-plan

Conversation

@empeje
Copy link
Copy Markdown

@empeje empeje commented Mar 29, 2026

Solves #63

This is warm up for my GSoC :)

Copilot AI review requested due to automatic review settings March 29, 2026 19:46
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds/updates Javadoc to remove a TODO and better describe JSON serialization helpers in the execution plan model (addresses #63).

Changes:

  • Replaces the ExecutionPlan.toJsonList() TODO with descriptive Javadoc.
  • Adds Javadoc to ExecutionStage.toJsonMap() describing its JSON-serializable map output.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/plan/executionplan/ExecutionStage.java Adds Javadoc for toJsonMap() (map representation for JSON serialization).
wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/plan/executionplan/ExecutionPlan.java Replaces TODO with Javadoc for toJsonList() (list of stage maps).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

empeje and others added 2 commits March 29, 2026 21:49
…e/plan/executionplan/ExecutionStage.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…e/plan/executionplan/ExecutionPlan.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants