Skip to content

Commit c68c1a5

Browse files
codegen-teamcodegen-team
committed
docs: updated API reference
1 parent ac9157a commit c68c1a5

File tree

154 files changed

+1392
-160
lines changed

Some content is hidden

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

154 files changed

+1392
-160
lines changed

‎docs/api-reference/core/Argument.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ 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/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
115+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/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=""/>
@@ -320,6 +320,14 @@ Inserts text before this node's source with optional indentation and newline han
320320
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
321321

322322

323+
### <span className="text-primary">is_child_of</span>
324+
Checks if this node is a descendant of the given editable instance in the AST.
325+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
326+
327+
328+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
329+
330+
323331
### <span className="text-primary">is_wrapped_in</span>
324332
Check if this node is contained another node of the given class
325333
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/Assignment.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Insert a keyword in the appropriate place before this symbol if it doesn't alrea
149149

150150
### <span className="text-primary">ancestors</span>
151151
Find all ancestors of the node of the given type. Does not return itself
152-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
152+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
153153

154154

155155
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -386,6 +386,14 @@ Inserts text before the current symbol node in the Abstract Syntax Tree.
386386
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
387387

388388

389+
### <span className="text-primary">is_child_of</span>
390+
Checks if this node is a descendant of the given editable instance in the AST.
391+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
392+
393+
394+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
395+
396+
389397
### <span className="text-primary">is_wrapped_in</span>
390398
Check if this node is contained another node of the given class
391399
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/AssignmentStatement.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
9999
<HorizontalDivider />
100100
### <span className="text-primary">ancestors</span>
101101
Find all ancestors of the node of the given type. Does not return itself
102-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
102+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
103103

104104

105105
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -299,6 +299,14 @@ Inserts text before this node's source with optional indentation and newline han
299299
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
300300

301301

302+
### <span className="text-primary">is_child_of</span>
303+
Checks if this node is a descendant of the given editable instance in the AST.
304+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
305+
306+
307+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
308+
309+
302310
### <span className="text-primary">is_wrapped_in</span>
303311
Check if this node is contained another node of the given class
304312
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/Attribute.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
119119
<HorizontalDivider />
120120
### <span className="text-primary">ancestors</span>
121121
Find all ancestors of the node of the given type. Does not return itself
122-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
122+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
123123

124124

125125
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -350,6 +350,14 @@ Inserts text before this node's source with optional indentation and newline han
350350
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
351351

352352

353+
### <span className="text-primary">is_child_of</span>
354+
Checks if this node is a descendant of the given editable instance in the AST.
355+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
356+
357+
358+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
359+
360+
353361
### <span className="text-primary">is_wrapped_in</span>
354362
Check if this node is contained another node of the given class
355363
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/AwaitExpression.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
7575
<HorizontalDivider />
7676
### <span className="text-primary">ancestors</span>
7777
Find all ancestors of the node of the given type. Does not return itself
78-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
78+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
7979

8080

8181
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -275,6 +275,14 @@ Inserts text before this node's source with optional indentation and newline han
275275
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
276276

277277

278+
### <span className="text-primary">is_child_of</span>
279+
Checks if this node is a descendant of the given editable instance in the AST.
280+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
281+
282+
283+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
284+
285+
278286
### <span className="text-primary">is_wrapped_in</span>
279287
Check if this node is contained another node of the given class
280288
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/BinaryExpression.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
8787
<HorizontalDivider />
8888
### <span className="text-primary">ancestors</span>
8989
Find all ancestors of the node of the given type. Does not return itself
90-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
90+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
9191

9292

9393
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -287,6 +287,14 @@ Inserts text before this node's source with optional indentation and newline han
287287
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
288288

289289

290+
### <span className="text-primary">is_child_of</span>
291+
Checks if this node is a descendant of the given editable instance in the AST.
292+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
293+
294+
295+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
296+
297+
290298
### <span className="text-primary">is_wrapped_in</span>
291299
Check if this node is contained another node of the given class
292300
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/BlockStatement.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Adds a decorator to a function or method.
122122

123123
### <span className="text-primary">ancestors</span>
124124
Find all ancestors of the node of the given type. Does not return itself
125-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
125+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
126126

127127

128128
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -322,6 +322,14 @@ Inserts text before this node's source with optional indentation and newline han
322322
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
323323

324324

325+
### <span className="text-primary">is_child_of</span>
326+
Checks if this node is a descendant of the given editable instance in the AST.
327+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
328+
329+
330+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
331+
332+
325333
### <span className="text-primary">is_wrapped_in</span>
326334
Check if this node is contained another node of the given class
327335
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/Boolean.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
7171
<HorizontalDivider />
7272
### <span className="text-primary">ancestors</span>
7373
Find all ancestors of the node of the given type. Does not return itself
74-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
74+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
7575

7676

7777
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -271,6 +271,14 @@ Inserts text before this node's source with optional indentation and newline han
271271
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
272272

273273

274+
### <span className="text-primary">is_child_of</span>
275+
Checks if this node is a descendant of the given editable instance in the AST.
276+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
277+
278+
279+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
280+
281+
274282
### <span className="text-primary">is_wrapped_in</span>
275283
Check if this node is contained another node of the given class
276284
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/Callable.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
9191
<HorizontalDivider />
9292
### <span className="text-primary">ancestors</span>
9393
Find all ancestors of the node of the given type. Does not return itself
94-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
94+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
9595

9696

9797
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -373,6 +373,14 @@ Inserts text before this node's source with optional indentation and newline han
373373
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
374374

375375

376+
### <span className="text-primary">is_child_of</span>
377+
Checks if this node is a descendant of the given editable instance in the AST.
378+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
379+
380+
381+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
382+
383+
376384
### <span className="text-primary">is_wrapped_in</span>
377385
Check if this node is contained another node of the given class
378386
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

‎docs/api-reference/core/CatchStatement.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Adds a decorator to a function or method.
126126

127127
### <span className="text-primary">ancestors</span>
128128
Find all ancestors of the node of the given type. Does not return itself
129-
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1110-L1118" />
129+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1119-L1127" />
130130

131131

132132
<Return return_type={ <><span>list[</span> <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable</a> <span>]</span></> } description=""/>
@@ -326,6 +326,14 @@ Inserts text before this node's source with optional indentation and newline han
326326
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">None</code> } description=""/>
327327

328328

329+
### <span className="text-primary">is_child_of</span>
330+
Checks if this node is a descendant of the given editable instance in the AST.
331+
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1109-L1116" />
332+
333+
334+
<Return return_type={ <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">bool</code> } description=""/>
335+
336+
329337
### <span className="text-primary">is_wrapped_in</span>
330338
Check if this node is contained another node of the given class
331339
<GithubLinkNote link="https://github.com/codegen-sh/codegen/blob/develop/src/codegen/sdk/core/interfaces/editable.py#L1088-L1090" />

0 commit comments

Comments
 (0)