Skip to content

Commit 6f83f6b

Browse files
committed
Miscellaneous docstring edits
1 parent 1acafa3 commit 6f83f6b

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import io.temporal.common.converter.EncodedValues;
2424

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import io.temporal.common.converter.EncodedValues;
2424

2525
/**
26-
* Use DynamicSignalHandler to process any signal dynamically. This is useful for a library level
26+
* Use DynamicSignalHandler to process any signal dynamically. This is useful for library-level
2727
* code and implementation of DSLs.
2828
*
2929
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323
import io.temporal.common.converter.EncodedValues;
2424

2525
/**
26-
* Use DynamicUpdateHandler to process any update dynamically. This is useful for a library level
26+
* Use DynamicUpdateHandler to process any update dynamically. This is useful for library-level
2727
* code and implementation of DSLs.
2828
*
2929
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
3030
* DynamicUpdateListener. Only one such listener can be registered per workflow execution.
3131
*
32-
* <p>When registered any signals which don't have a specific handler will be delivered to it.
32+
* <p>When registered any updates which don't have a specific handler will be delivered to it.
3333
*
3434
* @see DynamicQueryHandler
3535
* @see DynamicSignalHandler

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* one type that implements DynamicWorkflow per worker is allowed.
3030
*
3131
* <p>The main use case for DynamicWorkflow is an implementation of custom Domain Specific Languages
32-
* (DSLs). A single implementation can implement a workflow type which definition is dynamically
32+
* (DSLs). A single implementation can implement a workflow type whose definition is dynamically
3333
* loaded from some external source.
3434
*
3535
* <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

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
import io.temporal.internal.sync.StubMarker;
2525

2626
/**
27-
* Supports signalling and cancelling any workflows by the workflow type and their id. This is
28-
* useful when an external workflow type is not known at the compile time and to call workflows in
27+
* Supports signalling and cancelling any workflow by the workflow type and their id. This is
28+
* useful when an external workflow type is not known at compile time and to call workflows in
2929
* other languages.
3030
*
3131
* @see Workflow#newUntypedExternalWorkflowStub(String)
@@ -47,7 +47,7 @@ static <T> ExternalWorkflowStub fromTyped(T typed) {
4747
}
4848
if (typed instanceof ChildWorkflowStub) {
4949
throw new IllegalArgumentException(
50-
"Use ChildWorkflowStub.fromTyped to extract sbub created through Workflow#newChildWorkflowStub");
50+
"Use ChildWorkflowStub.fromTyped to extract stub created through Workflow#newChildWorkflowStub");
5151
}
5252
@SuppressWarnings("unchecked")
5353
StubMarker supplier = (StubMarker) typed;

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
/**
2222
* Workflow encapsulates the orchestration of activities and child workflows. It can also answer to
23-
* synchronous queries and receive external events (also known as signals).
23+
* synchronous queries and receive other external requests (signals and updates).
2424
*
2525
* <h2>Workflow Interface</h2>
2626
*
@@ -65,15 +65,15 @@
6565
* started, a new instance of the workflow implementation object is created. Then, one of the
6666
* methods (depending on which workflow type has been started) annotated with {@literal @}{@link
6767
* io.temporal.workflow.WorkflowMethod} is invoked. As soon as this method returns the workflow,
68-
* execution is closed. While workflow execution is open, it can receive calls to signal and query
69-
* methods. No additional calls to workflow methods are allowed. The workflow object is stateful, so
70-
* query and signal methods can communicate with the other parts of the workflow through workflow
71-
* object fields.
68+
* execution is closed. While the workflow execution is open, it can receive calls to signal, update,
69+
* and query methods. No additional calls to workflow methods are allowed. The workflow object is
70+
* stateful, so query, signal, and update methods can communicate with the other parts of the workflow
71+
* through workflow object fields.
7272
*
7373
* <h3>Calling Activities</h3>
7474
*
7575
* {@link io.temporal.workflow.Workflow#newActivityStub(Class)} returns a client-side stub that
76-
* implements an activity interface. It takes activity type and activity options as arguments.
76+
* implements an activity interface. It takes an activity type and activity options as arguments.
7777
* Activity options are needed only if some of the required timeouts are not specified through the
7878
* {@literal @}{@link io.temporal.activity.ActivityMethod} annotation.
7979
*

0 commit comments

Comments
 (0)