locateDocstring

locateDocstring#

csoundengine.csoundlib.locateDocstring(lines)[source]#

Locate the docstring in this instr code

Parameters:

lines (list[str]) – the code to analyze, tipically the code inside an instr (between instr/endin), split into lines

Return type:

tuple[int | None, int]

Returns:

a tuple (firstline, lastline) indicating the location of the docstring within the given text. firstline will be None if no docstring was found