Adding \n to all Args In The Packages Docstrings.

[taylor-ennen]

Before I perform the work or write a script to do so, I'm hoping the maintainers of the project can weigh in on this change.

Overall it is quite simple:

Adding a \n to the end of a Docstring Arg vastly improves readability given different screen and window sizes, bringing a format into place. This would also be implementable if there is a standard format being implemented before changes can be made, ie. Black format.

I'll attach a couple of screen shots below that illustrate this change and the readability I mentioned above.

Without the suggested changes:

With the suggested changes:

@sonichi I believe this is something I can accomplish on my own if you agree to the proposed changes in formatting standards, I can also help to add to the formatting tool used if there is one, I have not looked exhaustively though for a standard formatting tool at this point though.

Side note: I love the project and am working on implementing a Local Inference with a program LM Studio when I noticed these changes could be made, great work on this whole project; to all the contributors!

[sonichi]

The format looks good to me on https://microsoft.github.io/autogen/docs/reference/agentchat/conversable_agent
How are you viewing it?

[taylor-ennen]

The original screenshots I posted were captured while viewing the tooltip in VSCode.

[sonichi]

I see. Sure, give it a try. If adding \n makes both tooltip work and doesn't degrade the look on the website, good to make the change.

[taylor-ennen]

Awesome.
May I also ask, is there a formatting tool that is being used in the repo currently? I would be happy to look into how to add a rule to that formatting tool allowing this change to be added automatically to the docstrings.

[sonichi]

Yes. They are in https://github.com/microsoft/autogen/blob/main/pyproject.toml