From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Stephen Compall Newsgroups: gmane.lisp.guile.devel Subject: [PATCH]doco Manual Conventions Date: Mon, 17 Nov 2003 21:48:10 GMT Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Message-ID: <200311172148.hAHLmAda008250@csserver.evansville.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1069106247 19082 80.91.224.253 (17 Nov 2003 21:57:27 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 17 Nov 2003 21:57:27 +0000 (UTC) Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Mon Nov 17 22:57:24 2003 Return-path: Original-Received: from monty-python.gnu.org ([199.232.76.173]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1ALrN6-0004tQ-00 for ; Mon, 17 Nov 2003 22:57:24 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1ALsJY-0001RP-5k for guile-devel@m.gmane.org; Mon, 17 Nov 2003 17:57:48 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1ALsHs-0000hZ-Ka for guile-devel@gnu.org; Mon, 17 Nov 2003 17:56:04 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1ALsHL-0000UM-6u for guile-devel@gnu.org; Mon, 17 Nov 2003 17:56:02 -0500 Original-Received: from [192.195.228.35] (helo=csserver.evansville.edu) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.24) id 1ALsHI-0000Tn-J2 for guile-devel@gnu.org; Mon, 17 Nov 2003 17:55:28 -0500 Original-Received: from csserver.evansville.edu (localhost.localdomain [127.0.0.1]) by csserver.evansville.edu (8.12.8/8.12.8) with ESMTP id hAHLmAvS008258 for ; Mon, 17 Nov 2003 15:48:10 -0600 Original-Received: (from sc87@localhost) by csserver.evansville.edu (8.12.8/8.12.8/Submit) id hAHLmAda008250; Mon, 17 Nov 2003 21:48:10 GMT Original-To: guile-devel@gnu.org X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Developers list for Guile, the GNU extensibility library List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: main.gmane.org gmane.lisp.guile.devel:3048 X-Report-Spam: http://spam.gmane.org/gmane.lisp.guile.devel:3048 Continuing through the preface, I made some changes to node Manual Conventions. Please let me know if this ChangeLog is too detailed, and I will be more vague in the future. The patch is http://csserver.evansville.edu/~sc87/guile/Manual-Conventions-1sirian.patch ChangeLog and makeinfo output follow. 2003-11-17 Stephen Compall * preface.texi (Manual Conventions): Double-quote some statements formerly single-quoted. Remove some redundant quotes around code. Clarify meaning of `iff' further for those that didn't get it the first time 'round (like me). Make graphical indicators samples, not code. Put results of evaluation on the same line as @result symbols. Remove newlines between @itemize and first @item, and last @item and @end itemize. Use @print example as example of total usage, and remind readers not to forget the difference. Here is the Info output; again, you cannot see all the changes in this mode. Conventions used in this Manual ******************************* We use some conventions in this manual. * For some procedures, notably type predicates, we use "iff" to mean "if and only if". The construct is usually something like: "Return VAL iff CONDITION", where VAL is usually `#t' or non-`#f'. This typically means that VAL is returned if CONDITION holds, and that `#f' is returned otherwise. To clarify: VAL will *only* be returned when CONDITION is true. * In examples and procedure descriptions and all other places where the evaluation of Scheme expression is shown, we use some notation for denoting the output and evaluation results of expressions. The symbol `=>' is used to tell which value is returned by an evaluation: (+ 1 2) => 3 Some procedures produce some output besides returning a value. This is denoted by the symbol `-|'. (begin (display 1) (newline) 'hooray) -| 1 => hooray As you can see, this code prints `1' (denoted by `-|'), and returns `hooray' (denoted by `=>'). Do not confuse the two. -- Stephen Compall or s11 or sirian Deprive a mirror of its silver and even the Czar won't see his face. spies 9705 Samford Road eavesdropping electronic surveillance Honduras White House RSA cracking Defcon SCUD missile Verisign quarter arrangements government airframe _______________________________________________ Guile-devel mailing list Guile-devel@gnu.org http://mail.gnu.org/mailman/listinfo/guile-devel