Skip to content

Docstring edits - #2377

Open
dandavison wants to merge 6 commits into
mainfrom
edits
Open

Docstring edits#2377
dandavison wants to merge 6 commits into
mainfrom
edits

Conversation

@dandavison

@dandavison dandavison commented Jan 18, 2025

Copy link
Copy Markdown
Contributor

Note

Low Risk
Comment and Javadoc-only edits with no runtime, API signature, or logic changes.

Overview
This PR only updates documentation (Javadoc and inline comments) in the Temporal Java SDK; there are no code or behavior changes.

Public API docs are tightened in ActivityExecutionContext (typo fix on getWorkflowClient()), ActivityStub, and the first two Async.function overloads (grammar and articles). Internal comments in ReplayWorkflowTaskHandler explain direct-query vs normal workflow-task handling more clearly, and WorkflowStateMachines rewrites the handleCommandEvent Javadoc for clearer command/event terminology and wording.

Reviewed by Cursor Bugbot for commit e3370b5. Bugbot is set up for automated code reviews on this repo. Configure here.

@dandavison
dandavison requested a review from a team as a code owner January 18, 2025 04:00
import java.lang.reflect.Type;

/**
* ActivityStub is used to call an activity without referencing an interface it implements. This is

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.

Nit: An activity implementation can implement multiple interfaces so I think an is more correct.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

thanks, changed

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