Function getDocstring

AST inspection and construction utilities.

ast — factory object for building AST nodes by hand.
getDocstring — extract a function/class/module's docstring.
getSourceSegment — slice the original source text for a node.
isASTNode — type guard for AST node values.
iterFields / iterChildNodes — iterate a node's fields or direct child nodes.

getDocstring(node: ASTNodeUnion): string | null
Get the docstring from a function, class, or module node.

The docstring is the string literal that forms the first statement in the node's body, matching CPython's ast.get_docstring semantics.
Parameters
- node: ASTNodeUnion
  The function, class, or module node to inspect
Returns string | null
The docstring text, or null if the node has no body, isn't a function/class/module, or its first statement isn't a string constant
- Defined in utils.ts:12