Improve Run\RunWait Target parameter documentation Topic is solved

Share your ideas as to how the documentation can be improved.
TAC109
Posts: 1129
Joined: 02 Oct 2013, 19:41
Location: New Zealand

Improve Run\RunWait Target parameter documentation

26 Mar 2022, 17:48

A number of users have problems with the Target parameter when it contains spaces. I’m proposing this change to the documentation to clarify that quotes can be used to specify the exact target to use.

Replace the second paragraph of the Target parameter with the following two paragraphs:
To pass parameters, add them immediately after the program or document name.

If the program/document name or a parameter contains spaces, it is safest to enclose it in double quotes (even though it may work without them in some cases).
Cheers
My scripts:-
XRef - Produces Cross Reference lists for scripts
ReClip - A Text Reformatting and Clip Management utility
ScriptGuard - Protects Compiled Scripts from Decompilation
I also maintain Ahk2Exe
TAC109
Posts: 1129
Joined: 02 Oct 2013, 19:41
Location: New Zealand

Re: Improve Run\RunWait Target parameter documentation

31 Mar 2022, 17:47

@Ragnar Are you happy to make this documentation change, or would you like me to create a PR?

Cheers
My scripts:-
XRef - Produces Cross Reference lists for scripts
ReClip - A Text Reformatting and Clip Management utility
ScriptGuard - Protects Compiled Scripts from Decompilation
I also maintain Ahk2Exe
User avatar
Ragnar
Posts: 630
Joined: 30 Sep 2013, 15:25

Re: Improve Run\RunWait Target parameter documentation  Topic is solved

01 Apr 2022, 03:00

Thanks for reporting. Changes added in PR #527.
TAC109
Posts: 1129
Joined: 02 Oct 2013, 19:41
Location: New Zealand

Re: Improve Run\RunWait Target parameter documentation

01 Apr 2022, 03:37

Thanks!
My scripts:-
XRef - Produces Cross Reference lists for scripts
ReClip - A Text Reformatting and Clip Management utility
ScriptGuard - Protects Compiled Scripts from Decompilation
I also maintain Ahk2Exe
neogna2
Posts: 600
Joined: 15 Sep 2016, 15:44

Re: Improve Run\RunWait Target parameter documentation

01 Apr 2022, 15:46

TAC109 wrote:
26 Mar 2022, 17:48
To pass parameters, add them immediately after the program or document name.
@Ragnar A nitpick: the "immediately after" phrase is incorrect here because at least one separating space is required. The sentence could be changed to something like
To pass parameters, add a space after the program or document name and then add the parameters, each also separated by a space.
This could be added to the example section before the more complex example #3
Run a program and pass two parameters. The second parameter is a string that contains spaces so must be enclosed in quotes.
Run MyProgram.exe abc "string with spaces"
User avatar
Ragnar
Posts: 630
Joined: 30 Sep 2013, 15:25

Re: Improve Run\RunWait Target parameter documentation

02 Apr 2022, 09:55

It's not incorrect, it's just inaccurate, but it doesn't have to be that accurate. I've added an abstract example right after each case - that should be enough to understand.
neogna2
Posts: 600
Joined: 15 Sep 2016, 15:44

Re: Improve Run\RunWait Target parameter documentation

02 Apr 2022, 11:41

Ragnar wrote:
02 Apr 2022, 09:55
It's not incorrect, it's just inaccurate
I don't understand what the difference between incorrect and inaccurate means in this context. If the user adds a separating space the command works. If not the command fails. So why not explicitly document that the space is required? Other parts of the documentation, e.g. the "GUI Control Types" page, seem to use the phrase "immediately after" to instead describe syntax where an inbetween space is forbidden.

Return to “Suggestions on Documentation Improvements”

Who is online

Users browsing this forum: No registered users and 7 guests