Skip to content
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.

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

Improve doc formatting of initiate_chats #2041

Merged
merged 1 commit into from
Mar 17, 2024
Merged

Improve doc formatting of initiate_chats #2041

merged 1 commit into from
Mar 17, 2024

Conversation

gagb
Copy link
Collaborator

@gagb gagb commented Mar 17, 2024

Why are these changes needed?

This pull request includes a change to the initiate_chats method in the autogen/agentchat/chat.py file. The change simplifies the description of the chat_queue parameter, making it easier to understand in vscode.

Previously, the documentation was formatted in a manner that made it hard to read the documentation-- see before and after screenshots below. The change also made the language slightly concise.

Before:
Screenshot 2024-03-16 at 7 02 58 PM

After:
Screenshot 2024-03-16 at 7 03 33 PM

@codecov-commenter
Copy link

codecov-commenter commented Mar 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.41%. Comparing base (00972a6) to head (ee17f19).

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2041       +/-   ##
===========================================
+ Coverage   36.90%   48.41%   +11.50%     
===========================================
  Files          66       66               
  Lines        7031     7031               
  Branches     1538     1666      +128     
===========================================
+ Hits         2595     3404      +809     
+ Misses       4210     3341      -869     
- Partials      226      286       +60     
Flag Coverage Δ
unittests 48.28% <ø> (+11.37%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gagb gagb requested review from qingyun-wu, ekzhu and sonichi March 17, 2024 02:08
@gagb gagb added the documentation Improvements or additions to documentation label Mar 17, 2024
@gagb gagb requested a review from jackgerrits March 17, 2024 02:10
@sonichi sonichi added this pull request to the merge queue Mar 17, 2024
@sonichi
Copy link
Contributor

sonichi commented Mar 17, 2024

Thanks. There are many other format issues like this.

Merged via the queue into main with commit 448736e Mar 17, 2024
56 of 68 checks passed
@gagb gagb mentioned this pull request Mar 18, 2024
3 tasks
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
@gagb gagb deleted the improve-doc branch June 13, 2024 21:10
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants