It is no doc string in the elisp sense even though function and syntax are similar.
(de do_nothing () "Does nothing") Does not behave as expected. It returns the evaluated transient symbol "Does nothing". (de return_null () "returns 0" 0) (de muliply_increase_add (A B C) (let N (* A B) "N is A * B" (inc 'N 1) "N is increased by 1" (setq N (+ N C)) "Everything is done returning N now" N)) Is an extreme example which illustrates the trade-of both in terms of handling return values and readability. Also be careful around @, @@, @@@ with these. The resulting code is also slower. Comments are often preferred for that reason. 2017-03-28 19:26 GMT+02:00 Tim Johnson <t...@akwebsoft.com>: > * Joh-Tob Schäg <johtob...@gmail.com> [170323 22:18]: > > Either comments inside the code.# Like that > > > > Transistent Symbols at the beginn of the funtion. > > (de power (N E) > > "Calculates the exponent in a wastefull manner" > > (apply '* (need E N))) > > > > I have not seen another approach in Picolisp yet > > Am 24.03.2017 04:15 schrieb "Christopher Howard" < > > christopher.how...@qlfiles.net>: > > > > > Hi list. How does one document his picolisp code? Has anybody developed > > > any cool markup systems for use with picolisp? > > > > Joh-Tob seems to be describing a docstring as in elisp and python. > Does the docstring have to be the third member of the 'de form? > > Thanks > -- > Tim > http://www.akwebsoft.com, http://www.tj49.com > -- > UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe >
