Skip to content

Commit 8198727

Browse files
docs: updated docs to reflect latest changes
1 parent 474ead4 commit 8198727

File tree

177 files changed

+4570
-7292
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

+4570
-7292
lines changed

docs/api-reference/core/Argument.mdx

Lines changed: 17 additions & 33 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/codegen-sdk/blob/develop/src/codegen/sdk/core/detached_symbols/argument.py#L30-L155" />
14+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/detached_symbols/argument.py#L30-L156" />
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)
@@ -30,11 +30,6 @@ import {Attribute} from '/snippets/Attribute.mdx';
3030
<HorizontalDivider light={true} />
3131
<Attribute type={ <><a href="/api-reference/core/SourceFile" style={ {fontWeight: "inherit", fontSize: "inherit"} }>SourceFile</a></> } description="The file object that this Editable instance belongs to." />
3232

33-
### <span className="text-primary">file_node_id</span>
34-
<HorizontalDivider light={true} />
35-
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">NodeId</code> } description="
36-
" />
37-
3833
### <span className="text-primary">filepath</span>
3934
<HorizontalDivider light={true} />
4035
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">str</code> } description="The file path of the file that this Editable instance belongs to." />
@@ -59,15 +54,9 @@ import {Attribute} from '/snippets/Attribute.mdx';
5954
<HorizontalDivider light={true} />
6055
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">str | None</code> } description="Retrieves the base name of the object without namespace prefixes." />
6156

62-
### <span className="text-primary">node_type</span>
63-
<HorizontalDivider light={true} />
64-
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">NodeType</code> } description="
65-
" />
66-
6757
### <span className="text-primary">parent</span>
6858
<HorizontalDivider light={true} />
69-
<Attribute type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a></> } description="
70-
" />
59+
<Attribute type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a></> } description="The parent node of this Editable instance." />
7160

7261
### <span className="text-primary">parent_class</span>
7362
<HorizontalDivider light={true} />
@@ -89,11 +78,6 @@ import {Attribute} from '/snippets/Attribute.mdx';
8978
<HorizontalDivider light={true} />
9079
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">str</code> } description="Text representation of the Editable instance." />
9180

92-
### <span className="text-primary">ts_node</span>
93-
<HorizontalDivider light={true} />
94-
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">TSNode</code> } description="
95-
" />
96-
9781
### <span className="text-primary">type</span>
9882
<HorizontalDivider light={true} />
9983
<Attribute type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">str</code> } description="Gets the `Tree-sitter` type of the argument's value node." />
@@ -111,7 +95,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
11195
<HorizontalDivider />
11296
### <span className="text-primary">add_keyword</span>
11397
Converts an unnamed argument to a named argument by adding a keyword.
114-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/detached_symbols/argument.py#L105-L120" />
98+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/detached_symbols/argument.py#L105-L121" />
11599

116100
<ParameterWrapper>
117101
<Parameter
@@ -128,15 +112,15 @@ Converts an unnamed argument to a named argument by adding a keyword.
128112

129113
### <span className="text-primary">ancestors</span>
130114
Find all ancestors of the node of the given type. Does not return itself
131-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1082-L1090" />
115+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1096" />
132116

133117

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

136120

137121
### <span className="text-primary">edit</span>
138122
Replace the source of this `Editable` with `new_src`.
139-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L626-L654" />
123+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L632-L660" />
140124

141125
<ParameterWrapper>
142126
<Parameter
@@ -171,7 +155,7 @@ Replace the source of this `Editable` with `new_src`.
171155

172156
### <span className="text-primary">find</span>
173157
Find and return matching nodes or substrings within an Editable instance.
174-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L476-L493" />
158+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L482-L499" />
175159

176160
<ParameterWrapper>
177161
<Parameter
@@ -194,7 +178,7 @@ Find and return matching nodes or substrings within an Editable instance.
194178

195179
### <span className="text-primary">find_string_literals</span>
196180
Returns a list of string literals within this node's source that match any of the given
197-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L388-L402" />
181+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L394-L408" />
198182

199183
<ParameterWrapper>
200184
<Parameter
@@ -217,7 +201,7 @@ Returns a list of string literals within this node's source that match any of th
217201

218202
### <span className="text-primary">flag</span>
219203
Adds a visual flag comment to the end of this Editable's source text.
220-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L920-L931" />
204+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L926-L937" />
221205

222206

223207
<Return return_type={ <><span>CodeFlag[</span> <a href="/api-reference/core/Argument" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Argument</a> <span>]</span></> } description=""/>
@@ -233,7 +217,7 @@ Returns the name node of the object.
233217

234218
### <span className="text-primary">get_variable_usages</span>
235219
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
236-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L896-L912" />
220+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L902-L918" />
237221

238222
<ParameterWrapper>
239223
<Parameter
@@ -256,7 +240,7 @@ Returns Editables for all TreeSitter nodes corresponding to instances of variabl
256240

257241
### <span className="text-primary">insert_after</span>
258242
Inserts code after this node.
259-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L597-L623" />
243+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L603-L629" />
260244

261245
<ParameterWrapper>
262246
<Parameter
@@ -297,7 +281,7 @@ Inserts code after this node.
297281

298282
### <span className="text-primary">insert_before</span>
299283
Inserts text before this node's source with optional indentation and newline handling.
300-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L564-L594" />
284+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L570-L600" />
301285

302286
<ParameterWrapper>
303287
<Parameter
@@ -338,31 +322,31 @@ Inserts text before this node's source with optional indentation and newline han
338322

339323
### <span className="text-primary">is_wrapped_in</span>
340324
Check if this node is contained another node of the given class
341-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1068-L1070" />
325+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1074-L1076" />
342326

343327

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

346330

347331
### <span className="text-primary">parent_of_type</span>
348332
Find the first ancestor of the node of the given type. Does not return itself
349-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1073-L1079" />
333+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1079-L1085" />
350334

351335

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

354338

355339
### <span className="text-primary">reduce_condition</span>
356340
Reduces an editable to the following condition
357-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1024-L1029" />
341+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1030-L1035" />
358342

359343

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

362346

363347
### <span className="text-primary">remove</span>
364348
Deletes this Node and its related extended nodes (e.g. decorators, comments).
365-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L676-L691" />
349+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L682-L697" />
366350

367351
<ParameterWrapper>
368352
<Parameter
@@ -408,7 +392,7 @@ Sets the name of an object and updates all its usages.
408392

409393
### <span className="text-primary">replace</span>
410394
Search and replace occurrences of text within this node's source and its extended nodes.
411-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L421-L445" />
395+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L427-L451" />
412396

413397
<ParameterWrapper>
414398
<Parameter
@@ -449,7 +433,7 @@ Search and replace occurrences of text within this node's source and its extende
449433

450434
### <span className="text-primary">search</span>
451435
Returns a list of all regex match of `regex_pattern`, similar to python's re.search().
452-
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L509-L525" />
436+
<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L515-L531" />
453437

454438
<ParameterWrapper>
455439
<Parameter

0 commit comments

Comments
 (0)