The return type from ftfy's functions that provide an "explanation" of which steps it applied to fix the text, such as :func:`fix_and_explain()`. When the 'explain' option is disabled, these functions return the same type, but the `explanation` will be None.
| 59 | |
| 60 | |
| 61 | class ExplainedText(NamedTuple): |
| 62 | """ |
| 63 | The return type from ftfy's functions that provide an "explanation" of which |
| 64 | steps it applied to fix the text, such as :func:`fix_and_explain()`. |
| 65 | |
| 66 | When the 'explain' option is disabled, these functions return the same |
| 67 | type, but the `explanation` will be None. |
| 68 | """ |
| 69 | |
| 70 | text: str |
| 71 | explanation: list[ExplanationStep] | None |
| 72 | |
| 73 | |
| 74 | # Functions that can be applied using `apply_plan`. |
no outgoing calls
no test coverage detected