a-recknagel / stenotype

Support for shorthand type annotations.
MIT License
3 stars 2 forks source link

Add project description #3

Open a-recknagel opened 5 years ago

a-recknagel commented 5 years ago

The readme (and as an extension of it, the docs) doesn't have a project description yet. It would be nice to have, in order to know what is actually the goal, and how the project may help people.

Draft: Have something like this in it

Before:

from typing import List, Tuple, Union, Optional

def foo(var: Tuple[Union[bool, str], Optional[bool]]) -> List[Union[bool, str, None]]:
    ...

After:

import stenotype

def foo(var: (bool|str, bool|None)) -> [bool|str|None]:
    ...