autogen icon indicating copy to clipboard operation
autogen copied to clipboard

Multiline docstrings fix

Open sharsha315 opened this issue 11 months ago • 5 comments

Why are these changes needed?

  1. Added a first single line on RetrieveUserProxyAgent. The short definition line was taken by referring [here.]https://microsoft.github.io/autogen/blog/2023/10/18/RetrieveChat#introduction) first_single_line

  2. Formatted Docstrings in the RetrieveUserProxyAgent Class in autogen/autogen/agentchat/contrib/retrieve_user_proxy_agent.py file. formatted_docstrings_1

  3. Formatted docstrings for the initiate_chats functiion of ChatResult class in autogen/agentchat/chat.py file. formatted_docstrings_2

Related issue number

Closes #2048

Checks

  • [ ] I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
  • [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR.
  • [x] I've made sure all auto checks have passed.

sharsha315 avatar Mar 23 '24 14:03 sharsha315