Skip to content
This repository was archived by the owner on Jul 14, 2026. It is now read-only.

docs: correct JSDoc on Workflow.poll and WorkflowEngine.poll#2356

Merged
tim-smart merged 1 commit into
Effect-TS:mainfrom
biboete:fix/poll-jsdoc
Jun 11, 2026
Merged

docs: correct JSDoc on Workflow.poll and WorkflowEngine.poll#2356
tim-smart merged 1 commit into
Effect-TS:mainfrom
biboete:fix/poll-jsdoc

Conversation

@biboete

@biboete biboete commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Fixes #2336.

The poll method only polls the current status of a workflow execution; it does not execute the workflow. The JSDoc summary lines were copy-pasted from the neighbouring execute blocks and therefore described execution behaviour incorrectly.

This corrects the two summary lines:

  • packages/effect/src/unstable/workflow/Workflow.ts: the block above readonly poll: now reads "Poll the current status of a workflow execution." instead of "Execute the workflow with the given payload."
  • packages/effect/src/unstable/workflow/WorkflowEngine.ts: the block above readonly poll: now reads "Poll the current status of a registered workflow execution." instead of "Execute a registered workflow."

The correct execute JSDoc blocks in both files are left untouched.

Fixes Effect-TS#2336. The `poll` method only polls the current status of a
workflow execution; it does not execute the workflow. Update the JSDoc
summary lines accordingly in both Workflow.ts and WorkflowEngine.ts.
@changeset-bot

changeset-bot Bot commented Jun 9, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6bb33b6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tim-smart tim-smart enabled auto-merge (squash) June 11, 2026 03:12
@tim-smart tim-smart merged commit 44a7897 into Effect-TS:main Jun 11, 2026
14 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Bundle Size Analysis

File Name Current Size Previous Size Difference
basic.ts 6.72 KB 6.47 KB +0.25 KB (+3.83%)
batching.ts 9.23 KB 8.98 KB +0.25 KB (+2.74%)
brand.ts 6.19 KB 6.14 KB +0.05 KB (+0.85%)
cache.ts 9.70 KB 9.67 KB +0.03 KB (+0.34%)
config.ts 18.39 KB 18.52 KB -0.13 KB (-0.70%)
differ.ts 16.86 KB 17.01 KB -0.15 KB (-0.91%)
http-client.ts 20.20 KB 20.17 KB +0.03 KB (+0.17%)
logger.ts 10.18 KB 9.97 KB +0.22 KB (+2.19%)
metric.ts 8.56 KB 8.32 KB +0.24 KB (+2.88%)
optic.ts 7.37 KB 7.35 KB +0.02 KB (+0.24%)
pubsub.ts 13.80 KB 13.76 KB +0.04 KB (+0.30%)
queue.ts 11.08 KB 10.85 KB +0.23 KB (+2.16%)
schedule.ts 10.08 KB 10.04 KB +0.04 KB (+0.40%)
schema-representation-roundtrip.ts 26.27 KB 26.47 KB -0.20 KB (-0.76%)
schema-string-transformation.ts 12.59 KB 12.67 KB -0.08 KB (-0.64%)
schema-string.ts 10.34 KB 10.42 KB -0.08 KB (-0.78%)
schema-template-literal.ts 13.94 KB 14.04 KB -0.10 KB (-0.72%)
schema-toArbitraryLazy.ts 20.54 KB 20.68 KB -0.14 KB (-0.69%)
schema-toCodeDocument.ts 21.12 KB 21.25 KB -0.13 KB (-0.61%)
schema-toCodecJson.ts 17.67 KB 17.84 KB -0.17 KB (-0.95%)
schema-toEquivalence.ts 17.60 KB 17.73 KB -0.13 KB (-0.74%)
schema-toFormatter.ts 17.43 KB 17.58 KB -0.15 KB (-0.86%)
schema-toJsonSchemaDocument.ts 19.96 KB 20.09 KB -0.13 KB (-0.67%)
schema-toRepresentation.ts 17.99 KB 18.15 KB -0.15 KB (-0.85%)
schema.ts 17.03 KB 17.18 KB -0.15 KB (-0.86%)
stm.ts 11.95 KB 11.72 KB +0.23 KB (+1.98%)
stream.ts 9.25 KB 9.10 KB +0.15 KB (+1.60%)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Workflow.poll and WorkflowEngine.poll have incorrect JSDocs

2 participants