bundles / scipy 2.0.0.dev0+git20260907.41eeb59 / scipy / _lib / doccer / unindent_string

function

`scipy._lib.doccer:unindent_string`

source: build-install/usr/lib/python3.14/site-packages/scipy/_lib/doccer.py:311

Signature

def unindent_string(docstring: str) → str

Summary

Set docstring to minimum indent for all lines, including first.

Parameters

docstring : str: The input docstring to unindent.

Returns

docstring : str: The unindented docstring.

Examples

unindent_string(' two')
unindent_string('  two\n   three')

✓

'two\n three'

Aliases

scipy.signal._filter_design.doccer.unindent_string