Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usability of the Python syntax -- field comments #242

Open
gvanrossum opened this issue Apr 23, 2024 · 0 comments
Open

Usability of the Python syntax -- field comments #242

gvanrossum opened this issue Apr 23, 2024 · 0 comments

Comments

@gvanrossum
Copy link
Contributor

gvanrossum commented Apr 23, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant