guile-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Scheme file docstring format


From: Neil Jerram
Subject: Re: Scheme file docstring format
Date: 16 Feb 2001 19:06:25 +0000

I wrote:

     ;; reverse-directory-listing DIR
     ;;
     ;; Returns a list of file names in directory DIR.  The ordering is
     ;; reversed with respect to the ordering produced naturally by
     ;; readdir.
     ;;
     ;;-Author: Neil Jerram
     ;;-Updated: 21st May 2000
     
     (define (reverse-directory-listing dir-name)

D'oh!  The blank line between the end of the comment and the `(define
...)' should _not_ be there.  According to my proposal, if the Scheme
file looked like this, `reverse-directory-listing' would not have a
docstring at all.  So this example should be:

;; reverse-directory-listing DIR
;;
;; Returns a list of file names in directory DIR.  The ordering is
;; reversed with respect to the ordering produced naturally by
;; readdir.
;;
;;-Author: Neil Jerram
;;-Updated: 21st May 2000
(define (reverse-directory-listing dir-name)
  ...)

Regards,
        Neil



reply via email to

[Prev in Thread] Current Thread [Next in Thread]