Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
Command reference - Remarks section content
Message
From
26/06/2002 18:33:42
 
 
To
All
General information
Forum:
Visual FoxPro
Category:
Visual FoxPro Product Documentation
Title:
Command reference - Remarks section content
Miscellaneous
Thread ID:
00672721
Message ID:
00672721
Views:
42
The Remarks section in many many Command Reference entries contains information that is specific to one Argument/Parameter and so does NOT belong in the Remarks section but rather should be stated within the description of the parameter/argument to which it applies.

Two simple examples are:

1) LOCAL command - though there is a description of VarList under the Parameters section, the constraint that items in the list are to be separated by commas is only mentioned in the Remarks section.

2) STRTRAN() function - this function has 6 parameters, 4 of which are optional. It is only down in the Remarks section that the statement is made "Specify –1 for optional parameters you want to skip over if you just need to specify the nFlags setting.". Now this is an important fact that is far too easily overlooked given its current placement. At a minimum it should be stated in the description of the nFlags parameter and ideally bears repeating in EVERY optional parameter's description.

There are countless examples where this kind of thing occurs. Yes, it lets one say that "it is in the documentation" but the fact of the matter is that poor placement makes it UNhelpful AND requires additional reading when it could easily be avoided.
Next
Reply
Map
View

Click here to load this message in the networking platform