Skip to content

Commit a91dcb1

Browse files
committed
Document AST code generation
1 parent 6a896eb commit a91dcb1

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

crates/ruff_python_ast/ast.toml

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,29 @@
2626
# Controls the name of the AnyNodeRef::is_foo_bar method. The default is the
2727
# group name in snake_case.
2828
#
29-
# rustdoc:
30-
# A rustdoc comment that is added to the group's enums.
29+
# doc:
30+
# A doc comment that is added to the group's enums.
3131
#
3232
# The following syntax node options are available:
3333
#
34+
# doc:
35+
# A doc comment that is added to the syntax node struct.
36+
#
37+
# derives:
38+
# List of derives to add to the syntax node struct. Clone, Debug, PartialEq are added by default.
39+
#
40+
# fields:
41+
# List of fields in the syntax node struct. Each field is a table with the
42+
# following keys:
43+
# * name - The name of the field.
44+
# * type - The type of the field. This can be a simple type name, or a type
45+
# type field uses a special syntax to describe the rust type:
46+
# * `Expr` - A single expression.
47+
# * `Expr?` - Option type.
48+
# * `Expr*` - A vector of Expr.
49+
# * `&Expr*` - A boxed slice of Expr.
50+
# These properties cannot be nested, for example we cannot create a vector of option types.
51+
#
3452
# variant:
3553
# The name of the enum variant for this syntax node. Defaults to the node
3654
# name with the group prefix removed. (That is, `StmtIf` becomes `If`.)

0 commit comments

Comments
 (0)