On Fri, 23 May 2003, Martin Stecher wrote:
How about just calling the command with its full name and then only
refering to the abbreviation as the code in the technical
description.
Example
7.1 The connection-start command
command code: CS
anonymous parameters: none
...
Would you use "CS" or "connection-start" in the examples? Full
names make examples much more readable and make readers feel like
they immediately know what is going on...
Due to the unnamed parameters, readers will need to refer to the
command descriptions all the time anyway to be able to understand
the examples. So, I would stick with "CS" in the examples and better
add more comments to the examples that help faster understanding of
what is going on.
OK. If there are no further suggestions, let's try this approach.
Alex.