From 6780061728d3427c1dceec394cd97c52e771896f Mon Sep 17 00:00:00 2001 From: Devon Hudson Date: Mon, 24 Jun 2024 14:56:13 -0600 Subject: [PATCH] Clarify func docs --- sygnal/gcmpushkin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sygnal/gcmpushkin.py b/sygnal/gcmpushkin.py index b7302874..6f86e396 100644 --- a/sygnal/gcmpushkin.py +++ b/sygnal/gcmpushkin.py @@ -749,7 +749,7 @@ def truncate_str(input: str, max_bytes: int) -> tuple[str, bool]: """ Truncate the given string. If the truncation would occur in the middle of a unicode character, that character will be removed entirely instead. - Appends a `…` character to imply the string was truncated. + Appends a `…` character to the resulting string when truncation occurs. Args: `input`: the string to be truncated