On Fri, 5 Jun 2020 16:56:06 +0000, Seymour J Metz wrote:

>My problem with gratuitous documentation is that they invariably get it wrong. 
>Describe the actual requirements and direct the reader to the appropriate 
>places for details. In this case, something like:
>
>    As with any command issued to an external environment, ensure that the
>    expression you use evaluates to the intended EXECIO command. In
>
That's more than enough.

>    particular, it may be prudent to always quote keywords to avoid 
>    confusion with variables with the same name.  For example, if you assign
>    the variable "stem" to a value other than 'STEM' and then use
>
That's too much.

>        EXECIO 5 DISKW ddname '(' STEM
>
>    instead of
>
>        EXECIO 5 DISKW ddname '( STEM'
>
>    in your code, you will not invoke the correct command.
>
>Would be reasonable if they have to spell it out.
>
I'd prefer, for reasons that you know well:
         'EXECIO 5 DISKW' ddname '( STEM compound_symbol.'

The examples should be correct, nearly foolproof.  Beyond that,
presumption of familiarity with "General Concepts" should suffice.

The trees shouldn't hide the forest.

-- gil

----------------------------------------------------------------------
For IBM-MAIN subscribe / signoff / archive access instructions,
send email to lists...@listserv.ua.edu with the message: INFO IBM-MAIN

Reply via email to