bundles / scipy 1.17.1 / scipy / _lib / doccer / unindent_string

function

`scipy._lib.doccer:unindent_string`

source: /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')

✓

Aliases

scipy.signal._filter_design.doccer.unindent_string