From 192e63ddbba4446bbf908a3fb4ee3741e897f8ba Mon Sep 17 00:00:00 2001 From: Walter Schulze Date: Thu, 17 Jun 2021 11:35:36 +0100 Subject: [PATCH] document that enforcing line length is best effort --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 378c7f40..e190f857 100644 --- a/README.md +++ b/README.md @@ -150,6 +150,8 @@ hello(mike, joe, robert) will be kept as-is, since it fits in a single line. +Note: The enforcing of line-length is best effort and will sometimes overrun the selected line length, because the algorithm is greedy. + ## Design principles The formatter was designed with these main principles in mind: