Suggested improvement of documentation : Introduction
Robert STRANDH <[email protected]> Mon, 2 Dec 2002 17:14:48 +0100
| Newsgroups | gmane.lisp.ilisp.general |
|---|---|
| Message-ID | <[email protected]> |
Section "Introduction" The section should not be called `Introduction' but `Features'. In an introduction, one expects more substance, such as concepts. The section lists versions of Emacs under which ILISP runs. Is that a complete list? (Emacs 21 is not mentioned for instance). "Packages are properly handled..." Phrases like this are essentially void of meaning. How about something like this (assuming that is what you mean by the phrase) When the user sends an expression from a Lisp source buffer for evaluation in an inferior Lisp process, ILISP automatically switches to the package that is indicated at the beginning of the buffer. The expression is therefore read by the inferior Lisp process with the correct current package. [I don't know what is meant by "...including the distinction between exported and internal symbols]. A similar remark is valid for the phrase "Handle Lisp errors". I really can't tell what that is supposed to mean. "... eval and compile of files ..." I would say "... evaluation and compilation of files ...". Also, I can't figure out what "optional switching and automatic calling" is supposed to mean. I mean, what does it mean to call a file or a region? And what does it mean to switch a definition? Perhaps something like this instead : "Evaluation and compilation of an entire file, or of a region, a definition, or an s-expression of a buffer. The user can specify for ILISP to switch to the inferior Lisp buffer after evaluation or compilation. The user can also specify that a function definition should be called after evaluation. Evaluation and compilation can be done either synchronously (ILISP waits for the answer), asynchronously (ILISP does not wait), or in batch mode (don't know what this means). Instead of "Super brackets", I would say something like: "ILISP has commands for closing all open parentheses of the current `defun' (in Emacs terminology). -- Robert Strandh --------------------------------------------------------------------- Greenspun's Tenth Rule of Programming: any sufficiently complicated C or Fortran program contains an ad hoc informally-specified bug-ridden slow implementation of half of Common Lisp. --------------------------------------------------------------------- ------------------------------------------------------- This sf.net email is sponsored by:ThinkGeek Welcome to geek heaven. http://thinkgeek.com/sf