cadence-java-client icon indicating copy to clipboard operation
cadence-java-client copied to clipboard

Incorrect Documentation for Worker, where it refers that options parameter provides things like DataConverter

Open Krashcan opened this issue 1 year ago • 1 comments

This is what the documentation is for Worker constructor

/**
   * Creates worker that connects to an instance of the Cadence Service.
   *
   * @param client client to the Cadence Service endpoint.
   * @param taskList task list name worker uses to poll. It uses this name for both decision and
   *     activity task list polls.
   * @param options Options (like {@link DataConverter} override) for configuring worker.
   */

link

WorkerOptions have changed now and no longer have DataConverter . DataConverter is being passed via client.getOptions().getDataConverter() . Documentation should be modified so that it is relevant to the current state.

Krashcan avatar Feb 28 '24 10:02 Krashcan

https://github.com/uber/cadence-java-client/pull/867

Krashcan avatar Feb 28 '24 17:02 Krashcan