From 576ec088fb62291c1f431873d39d26d508d2a18c Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Thu, 25 Oct 2018 20:26:09 -0700 Subject: doc: return value of list-builder methods. * txr.1: Document that the list-builder methods which add to the list have unspecified return values, and that the local functions set up by the build macro are the same way. --- txr.1 | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/txr.1 b/txr.1 index 970d6636..328a49f3 100644 --- a/txr.1 +++ b/txr.1 @@ -30185,6 +30185,8 @@ whereas .code add* adds elements at the front. +The return value of these methods is unspecified. + .TP* Example: .cblk @@ -30227,6 +30229,8 @@ Both methods have the property that the constructed list does not share structure with the input lists. +The return value of these methods is unspecified. + .TP* Example: .cblk @@ -30277,6 +30281,8 @@ which is an atom. This atom will simply be installed as the terminating atom of the list being constructed. +The return value of these methods is unspecified. + .TP* Example: .cblk @@ -30349,6 +30355,14 @@ Local functions which mimic the methods operate implicitly on this hidden variable, so that the object need not be mentioned as an argument. +With the exception of +.codn get , +these local functions +.codn get , +have unspecified return values, like the same-named +.code list-builder +methods. + .TP* Examples: .cblk -- cgit v1.2.3