[red-knot] Explore alternative notation for declaring file names in mdtests #15695
Labels
help wanted
Contributions especially welcome
red-knot
Multi-file analysis & type inference
testing
Related to testing Ruff itself
Description
Our mdtest framework allows multifile tests. The file's path is declared as an attribute in the code snippet:
The downside of this is that the paths arent visible when rendering the markdown file on Github, which makes it harder to understand the test.
We should explore if there are other notations for specifying a file's path that is visible when rendered on GitHub. We probably want to support both notations (the old and new one) for now to avoid having to rewrite all tests.
E.g. we could use a bold text right before a code snippet as the file path.
The ideal solution would be if we can get GitHub to render the file's attributes because even the information that it is a
pyi
file is relevant.The text was updated successfully, but these errors were encountered: