Add module level docstrings (#4652)

* Improve init docs

* Add docstring for messages

* Add docstring for agents

* Add docstring for teams

* Add doc string for conditions

* Add docs for ui

* Update module docstring in __init__.py

* Clarify BaseChatAgent description in __init__.py

* Fix formatting

python/packages/autogen-agentchat/src/autogen_agentchat/__init__.py

@@ -1,3 +1,8 @@
+"""
+This module provides the main entry point for the autogen_agentchat package.
+It includes logger names for trace and event logs, and retrieves the package version.
+"""
+
 import importlib.metadata
 
 TRACE_LOGGER_NAME = "autogen_agentchat"

python/packages/autogen-agentchat/src/autogen_agentchat/agents/__init__.py

@@ -1,3 +1,8 @@
+"""
+This module initializes various pre-defined agents provided by the package.
+BaseChatAgent is the base class for all agents in AgentChat.
+"""
+
 from ._assistant_agent import AssistantAgent, Handoff  # type: ignore
 from ._base_chat_agent import BaseChatAgent
 from ._code_executor_agent import CodeExecutorAgent

python/packages/autogen-agentchat/src/autogen_agentchat/conditions/__init__.py

@@ -1,3 +1,8 @@
+"""
+This module provides various termination conditions for controlling the behavior of
+multi-agent teams.
+"""
+
 from ._terminations import (
     ExternalTermination,
     HandoffTermination,

python/packages/autogen-agentchat/src/autogen_agentchat/messages.py

@@ -1,3 +1,9 @@
+"""
+This module defines various message types used for agent-to-agent communication.
+Each message type inherits from the BaseMessage class and includes specific fields
+relevant to the type of message being sent.
+"""
+
 from typing import List, Literal
 
 from autogen_core import FunctionCall, Image

python/packages/autogen-agentchat/src/autogen_agentchat/teams/__init__.py

@@ -1,3 +1,8 @@
+"""
+This module provides implementation of various pre-defined multi-agent teams.
+Each team inherits from the BaseGroupChat class.
+"""
+
 from ._group_chat._base_group_chat import BaseGroupChat
 from ._group_chat._magentic_one import MagenticOneGroupChat
 from ._group_chat._round_robin_group_chat import RoundRobinGroupChat

python/packages/autogen-agentchat/src/autogen_agentchat/ui/__init__.py

@@ -1,3 +1,7 @@
+"""
+This module implements utility classes for formatting/printing agent messages.
+"""
+
 from ._console import Console
 
 __all__ = ["Console"]