Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

`startUpdate` JavaDoc says "asynchronously" when it may not be

Abierto
#2,578 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
java
Área
documentation

Línea de trabajo

Abre temporal-sdk/src/main/java/io/temporal/client/WorkflowClient.java alrededor de la línea 704 e inspecciona el JavaDoc de los métodos startUpdate. Comprueba cómo se describe la opción waitForStage y, después, actualiza la documentación para que COMPLETED indique claramente que la llamada puede bloquearse; el trabajo estará terminado cuando el JavaDoc ya no implique que el método es siempre asíncrono.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Expected Behavior

The JavaDoc for startUpdate should indicate that when it's called with a waitForStage of WorkflowUpdateStage.COMPLETED, it's synchronous and blocks until the update is completed.

Actual Behavior

The JavaDoc for startUpdate says the following:

Start a zero argument update workflow request asynchronously.

However, the following code will block until the update is completed:

val updateOptions =
  UpdateOptions.newBuilder<UpdateResult>()
    .setResultClass(UpdateResult::class.java)
    .setWaitForStage(WorkflowUpdateStage.COMPLETED)
    .setUpdateId(updateId)
    .build()
val update = WorkflowClient.startUpdate(stub::doUpdate, updateOptions) // <-- blocks here
val result = update.getResult(5, TimeUnit.SECONDS)

The JavaDoc implies that startUpdate would ignore the waitForStage, always be asynchronous, and block on the update.getResult.

Steps to Reproduce the Problem

  1. Look at JavaDoc for startUpdate
  2. Assume startUpdate is always asynchronous
  3. Call startUpdate with a waitForStage of WorkflowUpdateStage.COMPLETED
  4. See that the startUpdate call was actually synchronous

Specifications

  • Version: latest master
  • Platform: n/a

Requesting that either the word asynchronously is removed from the JavaDoc for the startUpdate methods or it's clear that the function isn't asynchronous in a normal sense.

Thanks!

Lenguaje dominante
Java
Estrellas
433
Forks
249
Merge medio
6 d 5 h
PR fusionados (30 d)
25

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de temporalio/sdk-java

Todos los issues de temporalio/sdk-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.