Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Miscellaneous docstring and comment edits #2154

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import io.temporal.common.converter.EncodedValues;

/**
* Use DynamicQueryHandler to process any query dynamically. This is useful for a library level code
* Use DynamicQueryHandler to process any query dynamically. This is useful for library-level code
* and implementation of DSLs.
*
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
import io.temporal.common.converter.EncodedValues;

/**
* Use DynamicSignalHandler to process any signal dynamically. This is useful for a library level
* code and implementation of DSLs.
* Use DynamicSignalHandler to process any signal dynamically. This is useful for library-level code
* and implementation of DSLs.
*
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
* DynamicSignalListener. Only one such listener can be registered per workflow execution.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
import io.temporal.common.converter.EncodedValues;

/**
* Use DynamicUpdateHandler to process any update dynamically. This is useful for a library level
* code and implementation of DSLs.
* Use DynamicUpdateHandler to process any update dynamically. This is useful for library-level code
* and implementation of DSLs.
*
* <p>Use {@link Workflow#registerListener(Object)} to register an implementation of the
* DynamicUpdateListener. Only one such listener can be registered per workflow execution.
*
* <p>When registered any signals which don't have a specific handler will be delivered to it.
* <p>When registered any updates which don't have a specific handler will be delivered to it.
*
* @see DynamicQueryHandler
* @see DynamicSignalHandler
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* one type that implements DynamicWorkflow per worker is allowed.
*
* <p>The main use case for DynamicWorkflow is an implementation of custom Domain Specific Languages
* (DSLs). A single implementation can implement a workflow type which definition is dynamically
* (DSLs). A single implementation can implement a workflow type whose definition is dynamically
* loaded from some external source.
*
* <p>Use {@link Workflow#getInfo()} to query information about the workflow type that should be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
import io.temporal.internal.sync.StubMarker;

/**
* Supports signalling and cancelling any workflows by the workflow type and their id. This is
* useful when an external workflow type is not known at the compile time and to call workflows in
* other languages.
* Supports signalling and cancelling any workflow by the workflow type and their id. This is useful
* when an external workflow type is not known at compile time and to call workflows in other
* languages.
*
* @see Workflow#newUntypedExternalWorkflowStub(String)
*/
Expand All @@ -47,7 +47,7 @@ static <T> ExternalWorkflowStub fromTyped(T typed) {
}
if (typed instanceof ChildWorkflowStub) {
throw new IllegalArgumentException(
"Use ChildWorkflowStub.fromTyped to extract sbub created through Workflow#newChildWorkflowStub");
"Use ChildWorkflowStub.fromTyped to extract stub created through Workflow#newChildWorkflowStub");
}
@SuppressWarnings("unchecked")
StubMarker supplier = (StubMarker) typed;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

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