restoration_note#

scikitplot.cleanprompt.restoration_note(result)[source]#

Return a one-line, secret-free description of a restoration.

Parameters:
resultRestorationResult

The pass to describe.

Returns:
str

A summary naming counts, and any unknown labels. Labels are not secrets, so naming them is safe and actionable.

Parameters:

result (RestorationResult)

Return type:

str

Examples

>>> restoration_note(RestorationResult("x", ("[EMAIL-1]",)))
'restored 1 placeholder(s)'