Skip to content

Updates Python Workflows docs to new sdk changes#28585

Merged
Caio-Nogueira merged 2 commits intoproductionfrom
caio/python-sdk-update
Feb 25, 2026
Merged

Updates Python Workflows docs to new sdk changes#28585
Caio-Nogueira merged 2 commits intoproductionfrom
caio/python-sdk-update

Conversation

@Caio-Nogueira
Copy link
Contributor

Summary

We recently made some changes to the Python Workflows SDK - cloudflare/workerd#5634

This PR introduces these modifications, as well as other updates regarding behavior that has changed in Python Workers

@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @cloudflare/wrangler, @mattietk, @cloudflare/dev-plat-leads
/src/content/docs/workflows/ @elithrar, @celso, @mia303, @jonesphillip, @cloudflare/pcx-technical-writing

Copy link
Contributor

@hoodmane hoodmane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@hoodmane
Copy link
Contributor

Not that I have merge rights here.

@Oxyjun
Copy link
Contributor

Oxyjun commented Feb 25, 2026

/bonk for API / parameter documentation (e.g. in src/content/docs/workflows/python/python-workers-api.mdx), use indented bullet points for each parameter.

Co-authored-by: Oxyjun <Oxyjun@users.noreply.github.com>
@ask-bonk
Copy link
Contributor

ask-bonk bot commented Feb 25, 2026

Zero errors. The changes are valid. Here's a summary of what was done:

Changes to src/content/docs/workflows/python/python-workers-api.mdx:

Converted parameter documentation for all four WorkflowStep methods from standalone paragraphs to indented sub-bullets under each method signature, matching the format used in the JS Workers API reference:

  • step.do — 3 parameters (name, concurrent, config) now shown as indented bullet points with em-dash separators
  • step.sleep — 2 parameters (name, duration) converted to indented bullets
  • step.sleep_until — 2 parameters (name, timestamp) converted to indented bullets
  • step.wait_for_event — 3 parameters (name, event_type, timeout) converted to indented bullets

Added {/* prettier-ignore */} comments before each method signature (consistent with the JS Workers API page at src/content/docs/workflows/build/workers-api.mdx:78) to prevent Prettier from reflowing the long <code> lines and collapsing the sub-bullet structure.

github run

@Caio-Nogueira Caio-Nogueira merged commit cd94869 into production Feb 25, 2026
9 checks passed
@Caio-Nogueira Caio-Nogueira deleted the caio/python-sdk-update branch February 25, 2026 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.