Skip to content

Python: Improve WorkflowBuilder doc strings with code samples #1960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Python: Improve WorkflowBuilder doc strings with code samples #1960

wants to merge 2 commits into from
+443 −31

Conversation

@moonbox3
Copy link
Contributor

@moonbox3 moonbox3 commented Nov 6, 2025

Motivation and Context

Improve WorkflowBuilder doc strings with code samples

Description

Improve WorkflowBuilder doc strings with code samples

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

@moonbox3 moonbox3 self-assigned this Nov 6, 2025
@moonbox3 moonbox3 added the documentation Improvements or additions to documentation label Nov 6, 2025
Copilot AI review requested due to automatic review settings November 6, 2025 06:32
@moonbox3 moonbox3 added python squad: workflows Agent Framework Workflows Squad workflows Related to Workflows in agent-framework labels Nov 6, 2025
@markwallace-microsoft
Copy link
Member

markwallace-microsoft commented Nov 6, 2025 •
edited
Loading

Python Test Coverage

Python Test Coverage Report •
FileStmtsMissCoverMissing
packages/core/agent_framework/_workflows
   _workflow_builder.py142894%172, 505–509, 511, 668
TOTAL12822191185% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
1698 107 💤 0 ❌ 0 🔥 33.199s ⏱️

Copilot AI reviewed Nov 6, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request significantly enhances the documentation for the WorkflowBuilder class in the Python agent framework by adding comprehensive docstrings with examples.

  • Expanded class-level documentation with a detailed example showing workflow construction
  • Added comprehensive examples to all public methods demonstrating their usage
  • Improved parameter descriptions and return type documentation
  • Fixed a typo in the add_fan_out_edges method description

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

Reviewers

Copilot code review Copilot Copilot left review comments

@eavanvalkenburg eavanvalkenburg eavanvalkenburg approved these changes

@TaoChenOSU TaoChenOSU Awaiting requested review from TaoChenOSU

@alliscode alliscode Awaiting requested review from alliscode

At least 2 approving reviews are required to merge this pull request.

Assignees

@moonbox3 moonbox3

Labels

documentation Improvements or additions to documentation python squad: workflows Agent Framework Workflows Squad workflows Related to Workflows in agent-framework

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Python: WorkflowBuilder docstrings

3 participants

@moonbox3 @markwallace-microsoft @eavanvalkenburg