Documentation DO help inadequate

May 20, 2008
3,515
4
Elkridge, MD, USA
1/ The format of single-line DO is mixed in with the list of loop control formats, instead of a separate display
2/ Not documented (except by inference in the list of loop control formats) that DO count and DO FOREVER cannot be used as single-line DO.
3/ There is no hyperlink from the list of loop control formats to an explanation of /P format details, though there is one to the option switch /P explanation.
 

rconn

Administrator
Staff member
May 14, 2008
12,404
152
1/ The format of single-line DO is mixed in with the list of loop control formats, instead of a separate display
2/ Not documented (except by inference in the list of loop control formats) that DO count and DO FOREVER cannot be used as single-line DO.
3/ There is no hyperlink from the list of loop control formats to an explanation of /P format details, though there is one to the option switch /P explanation.

1) WAD - there isn't any difference in the syntax of the DO statement. The single-line DO is explained in the Usage section. (I don't think it's useful to duplicate every syntax statement, once without & once with the "(command)" string.)
2) Not true -- they both can be used as a single-line DO (but you wouldn't want to).
3) There isn't any hyperlink because there isn't anything else to explain in the context of the DO keywords.

I deleted the duplicate message you posted on this topic.
 
May 20, 2008
3,515
4
Elkridge, MD, USA
1) I meant that something like this "Single-line: DO loop_control (command)" to appear ABOVE the line Loop_control formats. This would eliminate the need to display the DO keyword before and [(command)] after loop control syntax, hopefully making them less confusing.

2) My apologies - there was a mistake in my test cases for single line DO count and DO FOREVER.
 
Similar threads
Thread starter Title Forum Replies Date
fishman@panix.com Inadequate HELP for UNZIP command. Support 3
C Add link to ewriter help to program group... Support 3
samintz How to? Search for %(command) in Help? Support 1
Joe Caverly Favorites in eWriter Help Support 6
Joe Caverly Quick Search in eWriter Help Support 1
vefatica Online help? Support 2
fishman@panix.com HELP!! I just updated to Version 28 and as usual I cannot make extended directory search work. Support 2
JohnQSmith New online help file wrong logo Support 7
Jay Sage Documentation Function @DRIVE Missing in Help Lists Support 0
Charles Dye More help nits Support 0
D Documentation Typo in COPY help Support 0
FreezerBurnt Help making a CMD and TCC compatible batch file Support 7
Joe Caverly Documentation COMMANDS in Version 27 help Support 8
K_Meinhard How to? Help window position Support 7
U Command help on file names Support 5
D Documentation Help "Startup" page does not describe global lists Support 0
vefatica Help disappears? Support 6
rchapmanitt Help Purchasing Support 2
Charles Dye Documentation Help nits: @ZIPFILECRC Support 0
C version help Support 3
C Documentation Help Nit. REN / RENAME Support 0
Dmitry L. Kobyakov Documentation Error in the Help: the WINDOW command Support 0
vefatica Help for @PID Support 2
vefatica Need help with XML Support 3
Alpengreis Documentation Minor issue in help file for view /E Support 1
R Documentation Advanced Directives Help Support 0
R Documentation Help Nit with SETP Support 0
R wmic command help Support 9
R Documentation Help Nit > bdebugger View Menu Support 0
R Documentation A couple of Help nits Support 0
R Documentation Help typo Support 1
MikeBaas How to? I need help with RD Support 5
R Documentation v25 Help Comments Support 1
Joe Caverly DIRectory Colorization in v25 Help File Support 0
vefatica Help nit Support 0
D error in help documentation? Support 0
Joe Caverly _EXPANSION in help file Support 0
K_Meinhard Help file error Support 1
Joe Caverly JOBMONITOR in Help File Support 1
A Documentation [Help file] OPTION "//" synopsis formatting issue Support 0
D The local HELP viewer... Support 0
Chen Touboul Overtyping issue - i press the Insert key, help till press enter for new line in TCC Support 2
C Documentation Help nix ZIP /M Support 0
Joe Caverly v24 Help File - DATEMONITOR Support 1
Joe Caverly 7zip command links to zip help Support 0
K_Meinhard Help problems Support 3
Charles Dye Documentation Help Nits Forever: Checksum functions Support 0
Joe Caverly SAVECONSOLE in Help File Support 0
Joe Caverly CMDebug v23 Help: /FEEDBACK /UPDATE Support 0
Joe Caverly CMDebug v23 Help: Link to MOUNTVHD goes to MOUNTISO in UNMOUNTVHD Support 0

Similar threads