Skip to content

Commit b9d278d

Browse files
docs: updated API reference
1 parent e0865b2 commit b9d278d

File tree

177 files changed

+3992
-3989
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+3992
-3989
lines changed

docs/api-reference/core/Argument.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {HorizontalDivider} from '/snippets/HorizontalDivider.mdx';
1111
import {GithubLinkNote} from '/snippets/GithubLinkNote.mdx';
1212
import {Attribute} from '/snippets/Attribute.mdx';
1313

14-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/detached_symbols/argument.py#L30-L163" />
14+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/detached_symbols/argument.py#L30-L163" />
1515

1616
### Inherits from
1717
[HasValue](/api-reference/core/HasValue), [Expression](/api-reference/core/Expression), [HasName](/api-reference/core/HasName), [Editable](/api-reference/core/Editable)
@@ -95,7 +95,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
9595
<HorizontalDivider />
9696
### <span className="text-primary">add_keyword</span>
9797
Converts an unnamed argument to a named argument by adding a keyword.
98-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/detached_symbols/argument.py#L112-L128" />
98+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/detached_symbols/argument.py#L112-L128" />
9999

100100
<ParameterWrapper>
101101
<Parameter
@@ -112,15 +112,15 @@ Converts an unnamed argument to a named argument by adding a keyword.
112112

113113
### <span className="text-primary">ancestors</span>
114114
Find all ancestors of the node of the given type. Does not return itself
115-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1119-L1127" />
115+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1119-L1127" />
116116

117117

118118
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
119119

120120

121121
### <span className="text-primary">edit</span>
122122
Replace the source of this `Editable` with `new_src`.
123-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L637-L665" />
123+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L637-L665" />
124124

125125
<ParameterWrapper>
126126
<Parameter
@@ -155,7 +155,7 @@ Replace the source of this `Editable` with `new_src`.
155155

156156
### <span className="text-primary">find</span>
157157
Find and return matching nodes or substrings within an Editable instance.
158-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L487-L504" />
158+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L487-L504" />
159159

160160
<ParameterWrapper>
161161
<Parameter
@@ -178,7 +178,7 @@ Find and return matching nodes or substrings within an Editable instance.
178178

179179
### <span className="text-primary">find_string_literals</span>
180180
Returns a list of string literals within this node's source that match any of the given
181-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L398-L412" />
181+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L398-L412" />
182182

183183
<ParameterWrapper>
184184
<Parameter
@@ -201,23 +201,23 @@ Returns a list of string literals within this node's source that match any of th
201201

202202
### <span className="text-primary">flag</span>
203203
Adds a visual flag comment to the end of this Editable's source text.
204-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L939-L950" />
204+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L939-L950" />
205205

206206

207207
<Return return_type={ <><span>CodeFlag[</span> <a href="/api-reference/core/Argument" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Argument</a> <span>]</span></> } description=""/>
208208

209209

210210
### <span className="text-primary">get_name</span>
211211
Returns the name node of the object.
212-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/has_name.py#L52-L62" />
212+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/has_name.py#L52-L62" />
213213

214214

215215
<Return return_type={ <><a href="/api-reference/core/Name" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Name</a> <span>|</span> <a href="/api-reference/core/ChainedAttribute" style={ {fontWeight: "inherit", fontSize: "inherit"} }>ChainedAttribute</a> <span>| None</span></> } description="The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name."/>
216216

217217

218218
### <span className="text-primary">get_variable_usages</span>
219219
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
220-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L909-L925" />
220+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L909-L925" />
221221

222222
<ParameterWrapper>
223223
<Parameter
@@ -240,7 +240,7 @@ Returns Editables for all TreeSitter nodes corresponding to instances of variabl
240240

241241
### <span className="text-primary">insert_after</span>
242242
Inserts code after this node.
243-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L608-L634" />
243+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L608-L634" />
244244

245245
<ParameterWrapper>
246246
<Parameter
@@ -281,7 +281,7 @@ Inserts code after this node.
281281

282282
### <span className="text-primary">insert_before</span>
283283
Inserts text before this node's source with optional indentation and newline handling.
284-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L575-L605" />
284+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L575-L605" />
285285

286286
<ParameterWrapper>
287287
<Parameter
@@ -322,47 +322,47 @@ Inserts text before this node's source with optional indentation and newline han
322322

323323
### <span className="text-primary">is_child_of</span>
324324
Checks if this node is a descendant of the given editable instance in the AST.
325-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1109-L1116" />
325+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1109-L1116" />
326326

327327

328328
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
329329

330330

331331
### <span className="text-primary">is_wrapped_in</span>
332332
Check if this node is contained another node of the given class
333-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1088-L1090" />
333+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1088-L1090" />
334334

335335

336336
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
337337

338338

339339
### <span className="text-primary">parent_of_type</span>
340340
Find the first ancestor of the node of the given type. Does not return itself
341-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1093-L1099" />
341+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1093-L1099" />
342342

343343

344344
<Return return_type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>| None</span></> } description=""/>
345345

346346

347347
### <span className="text-primary">parent_of_types</span>
348348
Find the first ancestor of the node of the given type. Does not return itself
349-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1101-L1107" />
349+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1101-L1107" />
350350

351351

352352
<Return return_type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>| None</span></> } description=""/>
353353

354354

355355
### <span className="text-primary">reduce_condition</span>
356356
Reduces an editable to the following condition
357-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L1044-L1049" />
357+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L1044-L1049" />
358358

359359

360360
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
361361

362362

363363
### <span className="text-primary">remove</span>
364364
Deletes this Node and its related extended nodes (e.g. decorators, comments).
365-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L687-L702" />
365+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L687-L702" />
366366

367367
<ParameterWrapper>
368368
<Parameter
@@ -391,7 +391,7 @@ Deletes this Node and its related extended nodes (e.g. decorators, comments).
391391

392392
### <span className="text-primary">rename</span>
393393
Sets the name of an object and updates all its usages.
394-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/has_name.py#L80-L89" />
394+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/has_name.py#L80-L89" />
395395

396396
<ParameterWrapper>
397397
<Parameter
@@ -408,7 +408,7 @@ Sets the name of an object and updates all its usages.
408408

409409
### <span className="text-primary">replace</span>
410410
Search and replace occurrences of text within this node's source and its extended nodes.
411-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L432-L456" />
411+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L432-L456" />
412412

413413
<ParameterWrapper>
414414
<Parameter
@@ -449,7 +449,7 @@ Search and replace occurrences of text within this node's source and its extende
449449

450450
### <span className="text-primary">search</span>
451451
Returns a list of all regex match of `regex_pattern`, similar to python's re.search().
452-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/editable.py#L520-L536" />
452+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/editable.py#L520-L536" />
453453

454454
<ParameterWrapper>
455455
<Parameter
@@ -478,7 +478,7 @@ Returns a list of all regex match of `regex_pattern`, similar to python's re.sea
478478

479479
### <span className="text-primary">set_name</span>
480480
Sets the name of a code element.
481-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/has_name.py#L65-L77" />
481+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/has_name.py#L65-L77" />
482482

483483
<ParameterWrapper>
484484
<Parameter
@@ -495,7 +495,7 @@ Sets the name of a code element.
495495

496496
### <span className="text-primary">set_value</span>
497497
Sets the value of the node's value Expression.
498-
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/eagarwal/update-docs2/src/graph_sitter/core/interfaces/has_value.py#L23-L35" />
498+
<GithubLinkNote link="https://github.com/codegen-sh/graph-sitter/blob/develop/src/graph_sitter/core/interfaces/has_value.py#L23-L35" />
499499

500500
<ParameterWrapper>
501501
<Parameter

0 commit comments

Comments
 (0)