microsoft / TypeChat

TypeChat is a library that makes it easy to build natural language interfaces using types.
https://microsoft.github.io/TypeChat/
MIT License
8.06k stars 378 forks source link

Usability of the Python syntax -- field comments #242

Open gvanrossum opened 2 months ago

gvanrossum commented 2 months ago

When I was writing my Python schema I noticed that I have to use a rather verbose syntax to add comments to a schema:

    x: Annotated[int, Doc("X-coordinate of the top left corner.")]

Looking at the translated TypeScript schema, this gets turned into the much cleaner

    // Top left corner coordinates
    x: number;

I would like to be able to use native Python in-line comments, like this:

    x: int  # X-coordinate of the top left corner.

I think this could be implemented by scanning the source code instead of, or in addition to, passing the schema data structure.