Skip to content

gh-136640: Clarify the documentation of the AST module #136868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-136640: Clarify the documentation of the AST module #136868

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db02ddc
gh-136640: clarify documentation of AST subclasses attributes
Jul 20, 2025
bdc3e76
update proposal based on feedback
Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions Doc/library/ast.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@
end_lineno
end_col_offset

Instances of :class:`ast.expr` and :class:`ast.stmt` subclasses have
:attr:`lineno`, :attr:`col_offset`, :attr:`end_lineno`, and
:attr:`end_col_offset` attributes. The :attr:`lineno` and :attr:`end_lineno`
are the first and last line numbers of source text span (1-indexed so the
first line is line 1) and the :attr:`col_offset` and :attr:`end_col_offset`
Most classes part of the AST module have the :attr:`lineno`, :attr:`col_offset`,

Check warning on line 94 in Doc/library/ast.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:class reference target not found: ast.stmt [ref.class]

Check warning on line 94 in Doc/library/ast.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:class reference target not found: ast.expr [ref.class]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Most classes part of the AST module have the :attr:`lineno`, :attr:`col_offset`,
Most classes in the :mod:`!ast` module have the :attr:`lineno`, :attr:`col_offset`,

:attr:`end_lineno`, and :attr:`end_col_offset` attributes, including subclasses of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:attr:`end_lineno`, and :attr:`end_col_offset` attributes, including subclasses of
:attr:`end_lineno`, and :attr:`end_col_offset` attributes, including all subclasses of

:class:`ast.expr`, :class:`ast.stmt` and others (see
`Abstract Grammar <abstract-grammar_>`__). The :attr:`lineno` and
:attr:`end_lineno` are the first and last line numbers of source text span (1-indexed
so the first line is line 1) and the :attr:`col_offset` and :attr:`end_col_offset`
are the corresponding UTF-8 byte offsets of the first and last tokens that
generated the node. The UTF-8 offset is recorded because the parser uses
UTF-8 internally.
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy