Class PythonDocstrings

java.lang.Object

io.micronaut.python.processing.util.PythonDocstrings

@Internal
public final class PythonDocstrings
extends Object

Renders a Python docstring as element documentation.

Since:

5.2.0

Method Summary

Modifier and Type	Method	Description
static String	parse(String docstring)	Parses a Python docstring to extract the main description.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

parse

public static String parse(String docstring)

Parses a Python docstring to extract the main description. Removes opening/closing quotes and stops at structured sections like Args:, Returns:, etc.

Parameters:

docstring - the raw Python docstring

Returns:

the parsed main description, or empty string if docstring is null/empty