gh-148063: documentation: move ast.compare from "Compiler flags" to "ast helpers" (#147954)

This commit is contained in:
Hunter Hogan
2026-05-02 11:54:26 -05:00
committed by GitHub
parent bdedc4a20e
commit 7b0244dbc7
+14 -14
View File
@@ -2545,6 +2545,20 @@ and classes for traversing abstract syntax trees:
Added the *color* parameter.
.. function:: compare(a, b, /, *, compare_attributes=False)
Recursively compares two ASTs.
*compare_attributes* affects whether AST attributes are considered
in the comparison. If *compare_attributes* is ``False`` (default), then
attributes are ignored. Otherwise they must all be equal. This
option is useful to check whether the ASTs are structurally equal but
differ in whitespace or similar details. Attributes include line numbers
and column offsets.
.. versionadded:: 3.14
.. _ast-compiler-flags:
Compiler flags
@@ -2580,20 +2594,6 @@ effects on the compilation of a program:
.. versionadded:: 3.8
.. function:: compare(a, b, /, *, compare_attributes=False)
Recursively compares two ASTs.
*compare_attributes* affects whether AST attributes are considered
in the comparison. If *compare_attributes* is ``False`` (default), then
attributes are ignored. Otherwise they must all be equal. This
option is useful to check whether the ASTs are structurally equal but
differ in whitespace or similar details. Attributes include line numbers
and column offsets.
.. versionadded:: 3.14
.. _ast-cli:
Command-line usage