]> gitweb.factorcode.org Git - factor.git/commitdiff
prettyprint.config: adding some docs for has-limits?
authorJohn Benediktsson <mrjbq7@gmail.com>
Wed, 26 Jan 2022 16:55:30 +0000 (08:55 -0800)
committerJohn Benediktsson <mrjbq7@gmail.com>
Wed, 26 Jan 2022 16:55:30 +0000 (08:55 -0800)
basis/prettyprint/config/config-docs.factor

index a263ef3cc3f9962b67be2505c488ea04e931b994..90a16a898bb9bb8093a4eaa3e5c1c8afe979b890 100644 (file)
@@ -32,10 +32,25 @@ HELP: boa-tuples?
 HELP: c-object-pointers?
 { $var-description "Toggles whether C objects such as structs and direct arrays only print their underlying address. If this flag isn't set, C objects will attempt to print their contents. If a C object points to invalid memory, it will display only its address regardless." } ;
 
-HELP: with-short-limits
+HELP: has-limits?
+{ $var-description "Used to indicate that prettyprint limits have been set." } ;
+
+HELP: (with-short-limits)
 { $values { "quot" quotation } }
 { $description "Calls a quotation in a new dynamic scope with prettyprinter limits set to produce a single line of output." } ;
 
-HELP: without-limits
+HELP: with-short-limits
+{ $values { "quot" quotation } }
+{ $description "Calls a quotation in a new dynamic scope with prettyprinter limits set to produce a single line of output, if " { $link has-limits? } " is not set." } ;
+
+{ with-short-limits (with-short-limits) } related-words
+
+HELP: (without-limits)
 { $values { "quot" quotation } }
 { $description "Calls a quotation in a new dynamic scope with prettyprinter limits set to produce unlimited output." } ;
+
+HELP: without-limits
+{ $values { "quot" quotation } }
+{ $description "Calls a quotation in a new dynamic scope with prettyprinter limits set to produce unlimited output, if " { $link has-limits? } " is not set." } ;
+
+{ without-limits (without-limits) } related-words