run-llama/workflows-py
1
0
Fork 0
mirror of https://github.com/run-llama/workflows-py.git synced 2026-07-20 19:57:02 -04:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

[PR #63] [MERGED] docstrings for all the things #85

New Issue
Closed
opened 2026-02-16 02:16:32 -05:00 by yindo · 0 comments
yindo commented 2026-02-16 02:16:32 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/run-llama/workflows-py/pull/63
Author: @logan-markewich
Created: 8/10/2025
Status: ✅ Merged
Merged: 8/11/2025
Merged by: @logan-markewich

Base: main ← Head: logan/docstrings

📝 Commits (2)

📊 Changes

17 files changed (+880 additions, -221 deletions)

View changed files

📝 docs/docs/api_reference/workflow/context.md (+27 -3)
➕ docs/docs/api_reference/workflow/errors.md (+1 -0)
📝 docs/docs/api_reference/workflow/events.md (+2 -0)
➕ docs/docs/api_reference/workflow/handler.md (+1 -0)
➕ docs/docs/api_reference/workflow/resource.md (+1 -0)
📝 docs/mkdocs.yml (+1 -1)
📝 src/workflows/context/context.py (+260 -41)
📝 src/workflows/context/serializers.py (+99 -5)
📝 src/workflows/context/state_store.py (+127 -75)
📝 src/workflows/decorators.py (+37 -10)
📝 src/workflows/errors.py (+8 -8)
📝 src/workflows/events.py (+89 -34)
📝 src/workflows/handler.py (+30 -5)
📝 src/workflows/resource.py (+53 -0)
📝 src/workflows/retry_policy.py (+29 -11)
📝 src/workflows/types.py (+8 -0)
📝 src/workflows/workflow.py (+107 -28)

📄 Description

Huge overhaul to both the

  • docstrings
  • generated API reference

Now we have examples, things say the errors they raise, docstrings detail parameters, and tons of cross-linking. I think overall this makes it easier for anyone (including LLMs) to crawl our docs

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/run-llama/workflows-py/pull/63 **Author:** [@logan-markewich](https://github.com/logan-markewich) **Created:** 8/10/2025 **Status:** ✅ Merged **Merged:** 8/11/2025 **Merged by:** [@logan-markewich](https://github.com/logan-markewich) **Base:** `main` ← **Head:** `logan/docstrings` --- ### 📝 Commits (2) - [`431b596`](https://github.com/run-llama/workflows-py/commit/431b596806ddaaa3c676f3706422080b6fb985e8) Greatly expand API docs - [`9c9d0bb`](https://github.com/run-llama/workflows-py/commit/9c9d0bbd1bad0d32e1bd20646c31e7f394307ae2) add new api ref files ### 📊 Changes **17 files changed** (+880 additions, -221 deletions) <details> <summary>View changed files</summary> 📝 `docs/docs/api_reference/workflow/context.md` (+27 -3) ➕ `docs/docs/api_reference/workflow/errors.md` (+1 -0) 📝 `docs/docs/api_reference/workflow/events.md` (+2 -0) ➕ `docs/docs/api_reference/workflow/handler.md` (+1 -0) ➕ `docs/docs/api_reference/workflow/resource.md` (+1 -0) 📝 `docs/mkdocs.yml` (+1 -1) 📝 `src/workflows/context/context.py` (+260 -41) 📝 `src/workflows/context/serializers.py` (+99 -5) 📝 `src/workflows/context/state_store.py` (+127 -75) 📝 `src/workflows/decorators.py` (+37 -10) 📝 `src/workflows/errors.py` (+8 -8) 📝 `src/workflows/events.py` (+89 -34) 📝 `src/workflows/handler.py` (+30 -5) 📝 `src/workflows/resource.py` (+53 -0) 📝 `src/workflows/retry_policy.py` (+29 -11) 📝 `src/workflows/types.py` (+8 -0) 📝 `src/workflows/workflow.py` (+107 -28) </details> ### 📄 Description Huge overhaul to both the - docstrings - generated API reference Now we have examples, things say the errors they raise, docstrings detail parameters, and tons of cross-linking. I think overall this makes it easier for anyone (including LLMs) to crawl our docs --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-16 02:16:32 -05:00
yindo closed this issue 2026-02-16 02:16:32 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
enhancement
good first issue
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: run-llama/workflows-py#85
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?