Skip to content

Commit 49fc7ce

Browse files
committed
Add link to VERSIONS file format
1 parent 44c058b commit 49fc7ce

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

crates/red_knot_test/src/parser.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,17 @@ struct EmbeddedFileId;
133133

134134
/// A single file embedded in a [`Section`] as a fenced code block.
135135
///
136-
/// Currently must be a Python file (`py` language), a type stub (`pyi`) or a `VERSIONS` file.
136+
/// Currently must be a Python file (`py` language), a type stub (`pyi`) or a [typeshed `VERSIONS`]
137+
/// file.
138+
///
137139
/// TOML configuration blocks are also supported, but are not stored as `EmbeddedFile`s. In the
138140
/// future we plan to support `pth` files as well.
139141
///
140142
/// A Python embedded file makes its containing [`Section`] into a [`MarkdownTest`], and will be
141143
/// type-checked and searched for inline-comment assertions to match against the diagnostics from
142144
/// type checking.
145+
///
146+
/// [typeshed `VERSIONS`]: https://github.com/python/typeshed/blob/c546278aae47de0b2b664973da4edb613400f6ce/stdlib/VERSIONS#L1-L18
143147
#[derive(Debug)]
144148
pub(crate) struct EmbeddedFile<'s> {
145149
section: SectionId,

0 commit comments

Comments
 (0)