Utils: clarify why has_lines counts by splitting by newlines

1 files changed, 1 insertions, 0 deletions

diff --git a/bot/utils/helpers.py b/bot/utils/helpers.py
index b5c13ac9e..3501a3933 100644
--- a/bot/utils/helpers.py
+++ b/bot/utils/helpers.py
@@ -20,6 +20,7 @@ def find_nth_occurrence(string: str, substring: str, n: int) -> Optional[int]:
 
 def has_lines(string: str, count: int) -> bool:
     """Return True if `string` has at least `count` lines."""
+    # Benchmarks show this is significantly faster than using str.count("\n") or a for loop & break.
     split = string.split("\n", count - 1)
 
     # Make sure the last part isn't empty, which would happen if there was a final newline.