CommentGroup

A group of comments that form a larger comment block.

Inherits from

SymbolGroup, Editable

Attributes

extended

extended_source

file

filepath

function_calls

next_named_sibling

next_sibling

parent

parent_class

parent_function

parent_statement

source

symbols

text

variable_usages

Methods

ancestors

Find all ancestors of the node of the given type. Does not return itself

edit

Replace the source of this node with new text.

edit_text

Replace the text content of a comment group with new text.

find

Search for substrings in the given symbols that match strings_to_match.

find_string_literals

Search for string literals matching given strings in the SymbolGroup.

flag

Adds a visual flag comment to the end of this Editable’s source text.

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

insert_after

Inserts source code after this node in the codebase.

insert_before

Inserts source code before this symbol group.

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

is_wrapped_in

Check if this node is contained another node of the given class

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

reduce_condition

Reduces an editable to the following condition

remove

Removes this node and its related extended nodes from the codebase.

replace

Replaces all instances of a string with a new string in all symbols within the group.

search

Searches for regex matches in the codebase.