diff man/irccd-api-util.3 @ 963:371e1cc2c697

tests: add 80% of the Javascript API
author David Demelier <markand@malikania.fr>
date Thu, 28 Jan 2021 14:20:58 +0100
parents 0e11221c9bcc
children ec5461750efd
line wrap: on
line diff
--- a/man/irccd-api-util.3	Mon Jan 25 22:56:05 2021 +0100
+++ b/man/irccd-api-util.3	Thu Jan 28 14:20:58 2021 +0100
@@ -42,19 +42,11 @@
 The argument
 .Fa maxc
 controls the maximum of characters allowed per line, it can be a positive
-integer. If undefined is given, a default of 72 is used.
-.Pp
-The argument
+integer. If undefined is given, a default of 72 is used. The argument
 .Fa maxl
-controls the maximum of lines allowed. It can be a positive integer or undefined
-for an infinite list.
-.Pp
-If
-.Fa maxl
-is used as a limit and the data can not fit within the bounds,
-undefined is returned.
-.Pp
-An empty list may be returned if empty strings were found.
+controls the maximum of lines allowed. It can be a positive integer or
+undefined for an infinite list. An empty list may be returned if empty strings
+were found.
 .Pp
 .\" Irccd.Util.format
 The
@@ -118,7 +110,10 @@
 are negative numbers.
 .It Bq Er RangeError
 If one word length was bigger than
-.Fa maxc .
+.Fa maxc
+or the number of lines would exceed
+.Fa maxl
+argument.
 .It Bq Er TypeError
 If
 .Fa data