documentation: add experimental features flag guide to README #3567
Conversation
README.md
Outdated
| @@ -31,7 +31,7 @@ optimization capabilities. | |||
| - [xDSL Developer Setup](#xdsl-developer-setup) | |||
| - [Developer Installation](#developer-installation) | |||
| - [Testing](#testing) | |||
| - [Formatting](#formatting) | |||
| - [Formatting](#formatting-and-typechecking) | |||
There was a problem hiding this comment.
| - [Formatting](#formatting-and-typechecking) | |
| - [Formatting and Typechecking](#formatting-and-typechecking) |
|
What does the warning look like? never seen this markdown feature before |
|
It's a GH markdown feature, here's the new README from this PR: https://github.com/xdslproject/xdsl/blob/2b8fe6a1e5780333d2f8364e9178df0a8aad93e3/README.md And here's the doc: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts |
README.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
This looks like it's being promoted to a top-level heading in the important block
There was a problem hiding this comment.
Yep, Just changed to H4
README.md
Outdated
| > | ||
| > For xDSL to type check correctly using Pyright, please add this to your `pyproject.toml`: | ||
| > | ||
| > ``` text |
There was a problem hiding this comment.
| > ``` text | |
| > ```yaml |
or at least delete the space?
There was a problem hiding this comment.
Not sure if you wanted the real-time review
There was a problem hiding this comment.
My bad this should have been toml not yaml
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3567 +/- ##
=======================================
Coverage 90.39% 90.39%
=======================================
Files 467 467
Lines 58857 58857
Branches 5606 5606
=======================================
Hits 53206 53206
Misses 4207 4207
Partials 1444 1444 ☔ View full report in Codecov by Sentry. |
README.md
Outdated
| > | ||
| > For xDSL to type check correctly using Pyright, please add this to your `pyproject.toml`: | ||
| > | ||
| > ```yaml |
There was a problem hiding this comment.
| > ```yaml | |
| > ```toml |
…oject#3567) Adds missing documentation to xdslproject#3450
Adds missing documentation to #3450