bug-apl
[Top][All Lists]
Advanced

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

[Bug-apl] )HELP ...


From: David B. Lamkins
Subject: [Bug-apl] )HELP ...
Date: Mon, 17 Apr 2017 18:05:11 -0700
User-agent: Mutt/1.8.0 (2017-02-23)

Thank you to everyone who contributed to the recent extension to )HELP. This'll 
be far more convenient that flipping between APL and two PDF references.

Regarding help for user-defined functions, I'd like to offer a suggestion:

I've noticed quite a bit of talk about adopting syntax and/or semantics (e.g. 
tags) from the conventions used by other languages and documentation extractors.

I'd like to suggest that it's in everyone's interest for the format of header 
comments to remain as neutral as possible, leaving open the possibility for 
everyone to adopt (or invent) whatever convention they prefer.

The way I see it, the only real concern should be how to delimit the end of a 
header comment. I'd like to suggest that every lamp line starting with the 
first line of the function is a header comment regardless of indentation or 
markup. The end of the header comment is simply the first non-lamp line; this 
could be either a line of APL code or an empty line (and I prefer visual 
equivalence, so a line of only whitespace would be considered empty for this 
purpose). If the first line of the function is visually empty or a line of APL 
code, then the function has no header comment.

Again, thanks!

David

-- 
I've found my niche.  If you're wondering why I'm not there, there was
this little hole in the bottom ...
                -- John Croll



reply via email to

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