Skip to content

Commit

Permalink
documentation: add experimental features flag guide to README (#3567)
Browse files Browse the repository at this point in the history
Adds missing documentation to #3450
  • Loading branch information
superlopuh authored Dec 4, 2024
1 parent d81d66d commit 560b52f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ optimization capabilities.
- [xDSL Developer Setup](#xdsl-developer-setup)
- [Developer Installation](#developer-installation)
- [Testing](#testing)
- [Formatting](#formatting)
- [Formatting and Typechecking](#formatting-and-typechecking)

## Installation

Expand Down Expand Up @@ -135,6 +135,20 @@ Furthermore, all python code must run through [pyright](https://github.com/micro
without errors. Pyright can be run on all staged files through the
makefile using `make pyright`.

> [!IMPORTANT]
>
> #### Experimental Pyright Features
>
> xDSL currently relies on an experimental feature of Pyright called TypeForm
> TypeForm is [in discussion](https://discuss.python.org/t/pep-747-typeexpr-type-hint-for-a-type-expression/55984) and will likely land in some future version of Python.
>
> For xDSL to type check correctly using Pyright, please add this to your `pyproject.toml`:
>
> ```toml
> [tool.pyright]
> enableExperimentalFeatures = true
> ```
### Discussion
You can also join the discussion at our [Zulip chat room](https://xdsl.zulipchat.com), kindly supported by community hosting from [Zulip](https://zulip.com/).

0 comments on commit 560b52f

Please sign in to comment.