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.

Sign up for GitHub

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

documentation: add experimental features flag guide to README #3567

Merged
merged 10 commits into from
Dec 4, 2024
Merged

documentation: add experimental features flag guide to README #3567

Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0faa384
documentation: add experimental features flag guide to README
superlopuh Dec 4, 2024
d195277
WARNING
superlopuh Dec 4, 2024
33a81e0
shorten warning
superlopuh Dec 4, 2024
79eb942
Formatting and Typechecking
superlopuh Dec 4, 2024
5476965
warning test
superlopuh Dec 4, 2024
62d2e6f
try without heading
superlopuh Dec 4, 2024
2b8fe6a
add instructions back to tooltip
superlopuh Dec 4, 2024
57aea9e
H4
superlopuh Dec 4, 2024
4504b41
yaml syntax
superlopuh Dec 4, 2024
1c88997
toml not yaml
superlopuh Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
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`:
>
> ```yaml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> ```yaml
> ```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/).
Loading