diff --git a/README.md b/README.md index 43eaa9c..7a0a723 100644 --- a/README.md +++ b/README.md @@ -135,10 +135,13 @@ Then `dice.py` can be executed like: **Startle** is inspired by [Typer](https://github.com/fastapi/typer), [Fire](https://github.com/google/python-fire), and [HFArgumentParser](https://github.com/huggingface/transformers/blob/main/src/transformers/hf_argparser.py), -but aims to be _non-intrusive_, to have stronger type support, and to have saner defaults. +but aims to be [_non-intrusive_](https://oir.github.io/startle/#/design?id=non-intrusive), +to have stronger type support, and to have intuitive defaults. Thus, some decisions are done differently: -- Use of positional-only or keyword-only argument separators (`/`, `*`, see PEP 570, 3102) are naturally translated into positional arguments or options. +- Use of positional-only or keyword-only argument separators (`/`, `*`, see PEP + [570](https://peps.python.org/pep-0570/), [3102](https://peps.python.org/pep-3102/)) + are naturally translated into positional arguments or options. See above example ([wc.py](https://github.com/oir/startle/blob/main/examples/wc.py)). - Like Typer and unlike Fire, type hints strictly determine how the individual arguments are parsed and typed. - Short forms (e.g. `-k`, `-v` above) are automatically provided based on the initial of the argument. diff --git a/docs/README.md b/docs/README.md index 520fbbe..b66cea3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -139,7 +139,7 @@ Then `dice.py` could be executed like: **Startle** is inspired by [Typer](https://github.com/fastapi/typer), [Fire](https://github.com/google/python-fire), and [HFArgumentParser](https://github.com/huggingface/transformers/blob/main/src/transformers/hf_argparser.py), -but aims to be _non-intrusive_, to have stronger type support, and to have saner defaults. +but aims to be [_non-intrusive_](/design?id=non-intrusive), to have stronger type support, and to have intuitive defaults. Thus, some decisions are done differently: - Use of positional-only or keyword-only argument separators (`/`, `*`, see PEP [570](https://peps.python.org/pep-0570/),