Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.forth > #34792

van der Horsts Stallman convention (was: A poor mans memoizer.)

Show all headers | View raw

albert@spenarnc.xs4all.nl (Albert van der Horst) writes:
>No only expect I others to read my code, I try to convince the Forth
>world of a superior way of documenting.
>I should have added a reference to the Stallman convention:
>
>http://home.hccnet.nl/a.w.m.van.der.horst/forthlectureD.html

Note that in the Lisp and C code written by Richard Stallman, the
functions still have their formal paramater lists in addition to the
comments.  You are proposing to delete the stack comments, and replace
them with your comments that combine stack comments and description.
In order to do that, you put additional restrictions on the comment
that Stallman probably does not adhere to in general (it's easier to
write descriptions if you don't have to adhere to these restrictions).

Looking at an Emacs Lisp help text for a function, "C-h f
match-string", the formal parameters do not only appear in source
code, but even in the documentation away from the source code:

|match-string is a compiled Lisp function in `subr.el'.
|(match-string NUM &optional STRING)
|
|Return string of text matched by last search.
|NUM specifies which parenthesized expression in the last regexp.
| Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
|Zero means the entire text matched by the whole regexp or whole string.
|STRING should be given if the last search was by `string-match' on STRING.

It seems like Stallman does not think that the description replace the
formal parameter list, even with his convention.

Likewise, I think that the stack comment on its own is useful even if
it can be extracted out of your description given your restrictons.

- anton
-- 
M. Anton Ertl  http://www.complang.tuwien.ac.at/anton/home.html
comp.lang.forth FAQs: http://www.complang.tuwien.ac.at/forth/faq/toc.html
     New standard: http://www.forth200x.org/forth200x.html
   EuroForth 2014: http://www.euroforth.org/ef14/

Back to comp.lang.forth | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

A poor mans memoizer. albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-02 12:37 +0000
  Re: A poor mans memoizer. the_gavino_himself <visphatesjava@gmail.com> - 2014-12-02 05:37 -0800
  Re: A poor mans memoizer. "Elizabeth D. Rather" <erather@forth.com> - 2014-12-02 08:52 -1000
    Re: A poor mans memoizer. albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-03 13:17 +0000
      Re: A poor mans memoizer. "Elizabeth D. Rather" <erather@forth.com> - 2014-12-03 09:07 -1000
        Re: A poor mans memoizer. albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-04 09:08 +0000
          Re: A poor mans memoizer. Paul Rubin <no.email@nospam.invalid> - 2014-12-04 12:42 -0800
            Re: A poor mans memoizer. stephen@mpeforth.com (Stephen Pelc) - 2014-12-05 12:18 +0000
        Re: A poor mans memoizer. Mark Wills <markwills1970@gmail.com> - 2014-12-04 03:47 -0800
          Re: A poor mans memoizer. "Elizabeth D. Rather" <erather@forth.com> - 2014-12-04 08:43 -1000
      Re: A poor mans memoizer. mhx@iae.nl - 2014-12-03 14:47 -0800
        Re: A poor mans memoizer. albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-04 09:31 +0000
          Re: A poor mans memoizer. "Elizabeth D. Rather" <erather@forth.com> - 2014-12-04 08:58 -1000
            Re: A poor mans memoizer. albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-05 12:11 +0000
              van der Horsts Stallman convention (was: A poor mans memoizer.) anton@mips.complang.tuwien.ac.at (Anton Ertl) - 2014-12-05 12:23 +0000
                Re: van der Horsts Stallman convention "Elizabeth D. Rather" <erather@forth.com> - 2014-12-05 09:01 -1000
                Re: van der Horsts Stallman convention (was: A poor mans memoizer.) albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-06 10:06 +0000
      Re: A poor mans memoizer. Paul E Bennett <Paul_E.Bennett@topmail.co.uk> - 2014-12-04 10:19 +0000
        Should Forth Be Recommended Here? Celeros <kern000@gmail.com> - 2014-12-05 11:42 +0200
          Re: Should Forth Be Recommended Here? Paul E Bennett <Paul_E.Bennett@topmail.co.uk> - 2014-12-05 14:54 +0000
    Re: A poor mans memoizer. Rob Sciuk <rob@controlq.com> - 2014-12-05 14:08 -0500

csiph-web