Skip to content

Python: Improve WorkflowBuilder doc strings with code samples#1960

Merged
moonbox3 merged 3 commits intomicrosoft:mainfrom
moonbox3:improve-workflow-builder-docstrings
Nov 18, 2025
Merged

Python: Improve WorkflowBuilder doc strings with code samples#1960
moonbox3 merged 3 commits intomicrosoft:mainfrom
moonbox3:improve-workflow-builder-docstrings

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

Python Test Coverage

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

Python Unit Test Overview

Tests Skipped Failures Errors Time
2039 127 💤 0 ❌ 0 🔥 38.689s ⏱️

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

@moonbox3 moonbox3 added this pull request to the merge queue Nov 18, 2025
Merged via the queue into microsoft:main with commit e2d2299 Nov 18, 2025
23 checks passed
arisng pushed a commit to arisng/agent-framework that referenced this pull request Feb 2, 2026
…oft#1960)

* Improve WorkflowBuilder doc strings with code samples

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

Labels

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

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Python: WorkflowBuilder docstrings

5 participants