Hi Elias,
so its simply an APL comment at the beginning of the function?
I would still propose some kind of marker that distinguishes it from
normal APL comments
(and in order to make it Doxygen compatible).
/// Jürgen
On 07/31/2014 05:03 PM, Elias Mårtenson wrote:
Docstrings is documentation for a function, embedded in the function
definition itself, as discussed in a previous thread last week or so.
Here's an example for the Connect command:
https://github.com/lokedhs/apl-sqlite/blob/master/SQL.apl#L20
The Emacs mode uses this to provide integrated documentation, and I've
also written an APL function to extract this information (not ready
for common use): https://github.com/lokedhs/apl-tools/blob/master/doc.apl
Regards,
Elias
On 31 July 2014 22:59, Juergen Sauermann
<juergen.sauerm...@t-online.de <mailto:juergen.sauerm...@t-online.de>>
wrote:
Hi Elias,
I changed/removed the _5000 functions as proposed
What are docstrings?
/// Jürgen
On 07/31/2014 09:36 AM, Elias Mårtenson wrote:
I checked out the helper library for FILE_IO. Very nice.
First of all, how about adding docstrings in the same form as the
SQL library? I'm willing to help writing it if you want.
Secondly, I wonder why some functions are defined the way they
are though. For example, wouldn't it make more sense to define
FIO∆fread like this instead, and then skip the FIO∆fread_5000
function:
∇Zi ← blocksize FIO∆fread Bh
→(0≠⎕NC 'blocksize')/use¯blocksize
blocksize ← 5000
use¯blocksize:
Zi ← blocksize FILE_IO[6] Bh
∇
Regards,
Elias
