Skip to content

Improved documentation #267

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

Merged
pjljvandelaar merged 3 commits into from
Oct 9, 2026
Merged

Improved documentation #267

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd863fd
Improved documentation - text segment can be any piece of text in the…
pjljvandelaar Oct 9, 2026
5a550ef
Improved documentation of text segment
pjljvandelaar Oct 9, 2026
172a6b4
Merge branch 'main' into doc
pjljvandelaar Oct 9, 2026
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
6 changes: 5 additions & 1 deletion src/renaissance/syntax_tree/text_segment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ class TextSegment(Protocol):
"""Protocol for anything that represents a text segment.

A text segment is a consecutive piece, a.k.a. a slice, within a text.
Instances include comments, whitespace (incl. empty lines), and syntax nodes.
Any consecutive piece of text qualifies;
it need not correspond to a single syntactic construct.
Instances include comments, whitespace (incl. empty lines), syntax nodes,
combinations thereof, such as a syntax node together with its associated trivia,
and even a regular expression match, which has no relation to a syntax tree at all.

Read-only access is enforced "as much as possible" by
exposing only @property getters in the protocol.
Expand Down
Loading