Skip to content

Commit 1a1865f

Browse files
authored
Update README.md (#18)
Fix some typos and rephrase parts
1 parent cd82953 commit 1a1865f

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ This project implements a transpiler for creating [pyright](https://github.com/m
66
This is useful in a number of scenarios.
77
For example:
88

9-
- Automatic generation of type-safe APIs between Node.js and Python services
109
- Safely use JSON objects created by TypeScript projects in Python
11-
- A nice way to write complex Python types using TypeScript
10+
- Automatic generation of type-safe APIs between Node.js and Python applications
11+
- An easy way to write complex Python typings using TypeScript
1212

1313
## Example
1414

1515
### TypeScript
16+
1617
```ts
1718
export type Foo = {
1819
type: "foo"
@@ -102,8 +103,8 @@ This will result in optional entries beeing transpiled as `NotRequired[Optional[
102103
103104
## Limitations
104105
105-
We currently do not support the following features:
106+
The main focus of this project is transpiling type definitions for serializable data (e.g. JSON objects), and the following is not planned to be supported:
106107
107-
- Generics, as they cannot be fully supported by Python
108-
- Function signatures, as we restrict ourselves top serializable data
109-
- Values, as this is an extremely difficult problem and we currently only attempt to transpile types
108+
- Generics, as TypeScript's type system is much more powerful than Python's
109+
- Function signatures, as we restrict ourselves to serializable data
110+
- Anything that isn't a type definition

0 commit comments

Comments
 (0)