the help format parsing is not consistent about cyclopts HOT 2 CLOSED

#166 has been released with v2.6.2

from cyclopts.

There's definitely some inconsistencies; to be absolutely concrete, uploading some screenshots from your example code:

import cyclopts

app = cyclopts.App(help_format="rst")


@app.command
def div(x: int, y: int) -> int:
    """My application **[red]summary[/red]**.

    We can do RST things like have **bold text**.
    More words in this paragraph.

    This is a new paragraph with some bulletpoints below:

    * bullet point 1.
    * bullet point 2.

    Args:
        x (int):
        y (int): number [red bold]must to not be 0[/red bold]

    Returns:
        int: x/y

    """
    print(x / y)


if __name__ == "__main__":
    app()

I will be investigating, but would definitely like input on expected behavior. I never explicitly thought about people using rich markup in their text. I think it would be good to allow this where ever possible, but here it's causing some inconsistent behavior with rich-rst.

Currently I believe I'm only taking into account the format when rendering the main docstring; I should also take it into account when rendering "short description" and other related areas.

from cyclopts.