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

There's no Python specific documentation #244

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

There's no Python specific documentation #244

gvanrossum opened this issue Apr 23, 2024 · 2 comments

Comments

@gvanrossum
Copy link
Contributor

In the README.md of the python subtree there's this sentence:

To learn more about TypeChat, visit the documentation which includes more information on TypeChat and how to get started.

However, the docs found at that link are exclusively aimed at a TypeScript audience, and give no specifics about e.g. how to write a schema in Python. I had to glean that from the examples, which is far from ideal. I had hoped for something like a Python version of Basic TypeScript Usage.

@DanielRosenwasser
Copy link
Member

DanielRosenwasser commented Apr 29, 2024

I put together #237 a bit ago - it's not merged yet since the Python support is not yet published. But I guess I can merge it and just point out it's not yet published.

@gvanrossum
Copy link
Contributor Author

I put together #237 a bit ago - it's not merged yet since the Python support is not yet published. But I guess I can merge it and just point out it's not yet published.

Oh, that would definitely have saved me a buch of headscratching and spelunking. :-) I just gave it a quick review. Maybe it needn't be linked from the "general" TypeChat front page until it's published, but it ought to be at least reachable from the Python-specific README.ml (which I used as my starting point).

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

2 participants