[Issue]: Improve consistency of doc strings across modules

[gagb]

Describe the issue

Doc strings across all files lack consistency, presumably because different authors are using different conventions (including me). Eg, these are PEP 257 guidelines for multi-line doc strings:

It's easy to spot even the violations of the first para. For example:

• RetrieveUserProxyAgent does not have the first single line.
  

  autogen/autogen/agentchat/contrib/retrieve_user_proxy_agent.py

  Lines 64 to 76 in ee17f19

  	class RetrieveUserProxyAgent(UserProxyAgent):
  	def __init__(
  	self,
  	name="RetrieveChatAgent", # default set to RetrieveChatAgent
  	human_input_mode: Optional[str] = "ALWAYS",
  	is_termination_msg: Optional[Callable[[Dict], bool]] = None,
  	retrieve_config: Optional[Dict] = None, # config for the retrieve agent
  	**kwargs,
  	):
  	r"""
  	Args:
  	name (str): name of the agent.
  	human_input_mode (str): whether to ask for human inputs every time a message is received.

• initiate_chats uses extra indents that cause it to not render properly in vscode documentation pop outs.
  

  autogen/autogen/agentchat/chat.py

  Lines 134 to 143 in ee17f19

  	def initiate_chats(chat_queue: List[Dict[str, Any]]) -> List[ChatResult]:
  	"""Initiate a list of chats.
  	Args:
  	chat_queue (List[Dict]): a list of dictionaries containing the information about the chats.
  	Each dictionary should contain the input arguments for `ConversableAgent.initiate_chat`. For example:
  	"sender": the sender agent.
  	"recipient": the recipient agent.
  	"clear_history" (bool): whether to clear the chat history with the agent. Default is True.

cc. @ekzhu @jackgerrits

[jackgerrits]

Additionally, I think we should settle on Google style docstrings. There is great support for them and they are (in my opinion) the easiest to read. A large amount of the codebase already uses this style too. So it's really just making this fact explicit.

• https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
• https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e
• https://google.github.io/styleguide/pyguide.html#383-functions-and-methods

[gagb]

Additionally, I think we should settle on Google style docstrings.

Agreed.

[sharsha315]

Is this issue still open. Can I have the opportunity to work on this issue.

[RohitRathore1]

Is this issue still open. Can I have the opportunity to work on this issue.

@sharsha315 Yes, please go ahead.

[sharsha315]

Hi, a little help, Please. I made the necessary changes, formatted the docstrings, but when I make a commit I am getting an error and the git commit is getting failed. I have enclosed the snapshots of the errors.

[sharsha315]

Hi @RohitRathore1, a little help here. Please, help me with this above error, I am not able to go on further.

[jackgerrits]

This was fixed in main by fafc29e, please make sure you've updated to latest

[sharsha315]

This was fixed in main by fafc29e, please make sure you've updated to latest

Thank you for the quick response. It's working now.

[sharsha315]

Hi @RohitRathore1, I have submitted the PR. Please, review the PR and provide feedback. Thank you.

[RohitRathore1]

@sharsha315 Thanks for your PR. Please read the CLA & if you are agree with it then you can comment @microsoft-github-policy-service agree in the same PR.