Re: [Bug-apl] )HELP ...

[Elias Mårtenson]

I'm not sure that's even a different point of view. What you listed is common sense and I hope everybody who is developing code for more than one person abides by it. 

It also doesn't conflict with the idea of docstrings. What the double lamp signifies is the difference between documentation explaining how to use a function, vs. documentation explaining how the function accomplishes what it does. 

Regards, 

Elias 

On 18 Apr 2017 9:04 PM, "Peter Teeson" <address@hidden> wrote:

Actually for a slightly different POV…

Some criteria for writing maintainable APL from my days at Sharp:

a) Extracting only the comments should allow a competent APL’er to provide the missing code.

b) No horrendous one-liners

c) Code and comments may not exceed a single 8.5 x 11 sheet of paper.

The reason is that you absolutely don't want to display “normal” comments as documentation. 

FWIW