microsoft / microsoft/TypeChat

Usability of the Python syntax -- field comments

Open
#242 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
8.7k
Forks
414
Avg merge
3h 8m
Merged PRs (30d)
3

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how Python schema data is translated into the TypeScript schema, comparing the current Annotated/Doc representation with the generated field comments. The issue names no files or tests, so first locate the schema translation entry point and determine whether source scanning can preserve inline comments. Done means Python inline comments produce the expected TypeScript comments without breaking existing schema handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.