Skip to content

Commit f2fe3f5

Browse files
authored
Miscellaneous docstring and comment edits (#2154)
1 parent 50d15bd commit f2fe3f5

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

temporal-sdk/src/main/java/io/temporal/workflow/DynamicQueryHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import io.temporal.common.converter.EncodedValues;
44

55
/**
6-
* Use DynamicQueryHandler to process any query dynamically. This is useful for a library level code
6+
* Use DynamicQueryHandler to process any query dynamically. This is useful for library-level code
77
* and implementation of DSLs.
88
*
99
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the

temporal-sdk/src/main/java/io/temporal/workflow/DynamicSignalHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import io.temporal.common.converter.EncodedValues;
44

55
/**
6-
* Use DynamicSignalHandler to process any signal dynamically. This is useful for a library level
7-
* code and implementation of DSLs.
6+
* Use DynamicSignalHandler to process any signal dynamically. This is useful for library-level code
7+
* and implementation of DSLs.
88
*
99
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
1010
* DynamicSignalListener. Only one such listener can be registered per workflow execution.

temporal-sdk/src/main/java/io/temporal/workflow/DynamicUpdateHandler.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
import io.temporal.common.converter.EncodedValues;
44

55
/**
6-
* Use DynamicUpdateHandler to process any update dynamically. This is useful for a library level
7-
* code and implementation of DSLs.
6+
* Use DynamicUpdateHandler to process any update dynamically. This is useful for library-level code
7+
* and implementation of DSLs.
88
*
99
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
1010
* DynamicUpdateListener. Only one such listener can be registered per workflow execution.
1111
*
12-
* <p>When registered any signals which don't have a specific handler will be delivered to it.
12+
* <p>When registered any updates which don't have a specific handler will be delivered to it.
1313
*
1414
* @see DynamicQueryHandler
1515
* @see DynamicSignalHandler

temporal-sdk/src/main/java/io/temporal/workflow/DynamicWorkflow.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* one type that implements DynamicWorkflow per worker is allowed.
1212
*
1313
* <p>The main use case for DynamicWorkflow is an implementation of custom Domain Specific Languages
14-
* (DSLs). A single implementation can implement a workflow type which definition is dynamically
14+
* (DSLs). A single implementation can implement a workflow type whose definition is dynamically
1515
* loaded from some external source.
1616
*
1717
* <p>Use {@link Workflow#getInfo()} to query information about the workflow type that should be

temporal-sdk/src/main/java/io/temporal/workflow/ExternalWorkflowStub.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
import javax.annotation.Nullable;
66

77
/**
8-
* Supports signalling and cancelling any workflows by the workflow type and their id. This is
9-
* useful when an external workflow type is not known at the compile time and to call workflows in
10-
* other languages.
8+
* Supports signalling and cancelling any workflow by the workflow type and their id. This is useful
9+
* when an external workflow type is not known at compile time and to call workflows in other
10+
* languages.
1111
*
1212
* @see Workflow#newUntypedExternalWorkflowStub(String)
1313
*/
@@ -28,7 +28,7 @@ static <T> ExternalWorkflowStub fromTyped(T typed) {
2828
}
2929
if (typed instanceof ChildWorkflowStub) {
3030
throw new IllegalArgumentException(
31-
"Use ChildWorkflowStub.fromTyped to extract sbub created through Workflow#newChildWorkflowStub");
31+
"Use ChildWorkflowStub.fromTyped to extract stub created through Workflow#newChildWorkflowStub");
3232
}
3333
@SuppressWarnings("unchecked")
3434
StubMarker supplier = (StubMarker) typed;

temporal-sdk/src/main/java/io/temporal/workflow/package-info.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Workflow encapsulates the orchestration of activities and child workflows. It can also answer to
3-
* synchronous queries and receive external events (also known as signals).
3+
* synchronous queries and receive other external requests (signals and updates).
44
*
55
* <h2>Workflow Interface</h2>
66
*
@@ -45,15 +45,15 @@
4545
* started, a new instance of the workflow implementation object is created. Then, one of the
4646
* methods (depending on which workflow type has been started) annotated with {@literal @}{@link
4747
* io.temporal.workflow.WorkflowMethod} is invoked. As soon as this method returns the workflow,
48-
* execution is closed. While workflow execution is open, it can receive calls to signal and query
49-
* methods. No additional calls to workflow methods are allowed. The workflow object is stateful, so
50-
* query and signal methods can communicate with the other parts of the workflow through workflow
51-
* object fields.
48+
* execution is closed. While the workflow execution is open, it can receive calls to signal,
49+
* update, and query methods. No additional calls to workflow methods are allowed. The workflow
50+
* object is stateful, so query, signal, and update methods can communicate with the other parts of
51+
* the workflow through workflow object fields.
5252
*
5353
* <h3>Calling Activities</h3>
5454
*
5555
* {@link io.temporal.workflow.Workflow#newActivityStub(Class)} returns a client-side stub that
56-
* implements an activity interface. It takes activity type and activity options as arguments.
56+
* implements an activity interface. It takes an activity type and activity options as arguments.
5757
* Activity options are needed only if some of the required timeouts are not specified through the
5858
* {@literal @}{@link io.temporal.activity.ActivityMethod} annotation.
5959
*

0 commit comments

Comments
 (0)