AutoHotkey Homepage AutoHotkey Community
Let's help each other out
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

Suggestions on documentation improvements
Goto page Previous  1, 2, 3, 4, 5, 6 ... 11, 12, 13  Next
 
Reply to topic    AutoHotkey Community Forum Index -> Bug Reports
View previous topic :: View next topic  
Author Message
JDN



Joined: 24 Mar 2004
Posts: 299

PostPosted: Tue Jun 02, 2009 9:31 pm    Post subject: Reply with quote

I have found some minor typos in the Help file. I try to wait a few weeks and find several typos before posting. I think it would be a nuisance to post every time I find one. Here are five of them:

In the following list, I use the abbreviations "s.b." to mean "should be". I hope you can find all the following OK and that you can follow my meaning as to what is the problem and what is the solution.

------------------------------------------------------------------------------------

Functions - Builtin Functions - Substr - "Length is the maximum number of characters to retrieve (fewer than the maximum are retrieved whenever the remaining part of the string too short)." ... s.b. "of the string is too short)."

Variables and Expressions - Variable Types (very near top of section) - However, a variable containing only digits (with an optional decimal point) is automatically interpreted a number when a math operation or comparison requires it. ... s.b. "interpreted as a number"

also - (with an optional decimal point) ... sb ... (with an optional decimal point and/or minus sign) ? (I'm not sure if this is correct or not)

RegExMatch - Parameters - NeedleRegEx - followed by an close-parenthesis - s.b. "followed by a close parenthesis"

alphabetic list of commands - #winactivate force - "of of" s.b. "of".
Back to top
View user's profile Send private message
JDN



Joined: 24 Mar 2004
Posts: 299

PostPosted: Tue Jun 02, 2009 9:32 pm    Post subject: Reply with quote

The command SetTimer is listed under "Flow of Control" as well as "Misc Commands" under the Contents tab of the Help file.

I don't know if this might be an error or not. But I don't see any other commands listed in more than one category.
Back to top
View user's profile Send private message
lilalurl.T32



Joined: 17 May 2007
Posts: 391
Location: Titan

PostPosted: Mon Jun 22, 2009 9:38 pm    Post subject: Reply with quote

Missing i in classified, in the last sentence of the first paragraph of the entry for A-Cursor.

Quote:
The hand-shaped cursors (pointing and grabbing) are classified as Unknown.

________
DC MARIJUANA DISPENSARIES


Last edited by lilalurl.T32 on Fri Feb 11, 2011 9:07 pm; edited 1 time in total
Back to top
View user's profile Send private message
a_h_k



Joined: 02 Feb 2008
Posts: 627

PostPosted: Tue Jun 30, 2009 1:15 am    Post subject: Reply with quote

Exit

Is:
"Exits the current thread or (if the script is not persistent contains no hotkeys) the entire script."

Should be:
"Exits the current thread or (if the script is not persistent & contains no hotkeys) the entire script"



Also: Why not rid the trailing "." at end of lines/paragraphs? (at least for these description lines) --> It would look a bit better (i tend to avoid using "." whenever possible, leaving it to the realm of books/newspapers/etc !)
Anyway, you know that you have reached the end of the line/paragragh by way of the "EoL marker" (= <nothing>), so having the "." there as well is unecessary duplication of the EoL marker (like having CR/LF + TAB to mark end of file lines!) Smile

Code:
By "lines/paragraphs" I meant omitting . at end of single sentences, & at end paragraphs (last sentence):
A single sentence
             (no .)
A single sentence. Another single sentence. Yet another single sentence
                (.)                      (.)                       (no .)
Back to top
View user's profile Send private message Visit poster's website
a_h_k



Joined: 02 Feb 2008
Posts: 627

PostPosted: Thu Jul 02, 2009 2:32 am    Post subject: Reply with quote

Critical

Is:
Critical [, Off]
Critical 50 ; See bottom of remarks.

Should be:
Critical [, On|Off]
Critical MessageCheckInterval ; See bottom of remarks
Back to top
View user's profile Send private message Visit poster's website
SoLong&Thx4AllTheFish



Joined: 27 May 2007
Posts: 4999

PostPosted: Wed Jul 22, 2009 7:11 am    Post subject: A short note about different keyboard layouts Reply with quote

Perhaps add a short note about different keyboard layouts on these two pages:

http://www.autohotkey.com/docs/Hotkeys.htm
http://www.autohotkey.com/docs/Tutorial.htm

As some users may expect a simple #z to work while it generates an "Error: invalid hotkey" which may confuse a new scripter

See http://www.autohotkey.com/forum/viewtopic.php?t=46711

Edit: updated link
_________________
AHK Wiki FAQ
TF : Text files & strings lib, TF Forum


Last edited by SoLong&Thx4AllTheFish on Tue Aug 18, 2009 5:39 pm; edited 1 time in total
Back to top
View user's profile Send private message
Lexikos



Joined: 17 Oct 2006
Posts: 7299
Location: Australia

PostPosted: Sat Jul 25, 2009 3:37 pm    Post subject: Reply with quote

Quote:
If this is the letter A and the next 3 parameters are omitted, the active window will be used.

The above seems to apply to any command which accepts a window title, but the documention fails to mention it for several commands.

WinGet - Why?

WinActivate and WinActivateBottom - OK, there probably isn't any conceivable use for activating the active window.

WinShow, WinWait, IfWin and variations - If DetectHiddenWindows is Off, WinWaitClose or WinWaitNotActive can be used to wait for a hidden window to become active, while WinWait or WinWaitActive can be used to wait for a visible window to become active. Similarly, IfWin can be used to determine whether the active window is visible. One common example of a hidden active window: whenever a popup menu is shown, the window which owns it is activated. AutoHotkey's menus and all other tray icon menus I've tested are owned by hidden windows.

More importantly, WinActive() and WinExist() are often used to retrieve the ID of the active window. However, their sections in the documentation link to IfWinActive and IfWinExist, which do not mention "A". The following thread prompted my post: WinGetActiveID?.
Back to top
View user's profile Send private message Visit poster's website
Crash&Burn



Joined: 02 Aug 2009
Posts: 210

PostPosted: Tue Aug 04, 2009 3:23 am    Post subject: Rajat's Updated messages.txt for SendMessage / PostMessage Reply with quote

Can Rajat's updated messages.txt be added to the AutoHotkey.CHM?
Back to top
View user's profile Send private message
Lexikos



Joined: 17 Oct 2006
Posts: 7299
Location: Australia

PostPosted: Wed Aug 05, 2009 10:35 am    Post subject: Reply with quote

variables, MAIN wrote:
Variable names may be up to 254 characters long
Is this really correct? MAX_VAR_NAME_LENGTH is defined as (UCHAR_MAX - 2), i.e. 253.
Back to top
View user's profile Send private message Visit poster's website
infogulch



Joined: 27 Mar 2008
Posts: 649

PostPosted: Mon Aug 17, 2009 1:59 pm    Post subject: Reply with quote

The default values for SetKeyDelay are listed near the bottom of it's documentation. I think most people would expect this information to be listed in the parameter descriptions, especially since this command's defaults affect other commands.
_________________
Scripts - License
Back to top
View user's profile Send private message
infogulch



Joined: 27 Mar 2008
Posts: 649

PostPosted: Mon Aug 17, 2009 2:03 pm    Post subject: Reply with quote

Lexikos: you are correct, running the following test script, one sees that it fails at 254 characters, so the max is actually 253 characters:
Code:
loop
{
   ToolTip, Trying length: %A_Index%
   nam .= "a"
   %nam% := "Testing " A_Index
}

_________________
Scripts - License
Back to top
View user's profile Send private message
Lexikos



Joined: 17 Oct 2006
Posts: 7299
Location: Australia

PostPosted: Sat Aug 22, 2009 6:29 am    Post subject: Reply with quote

Quote:
When the Gui Submit command is used, the control's associated output variable (if any) receives the hotkey modifiers and name, which are be compatible with the Hotkey command.
Source: GUI Control Types
Back to top
View user's profile Send private message Visit poster's website
engunneer



Joined: 30 Aug 2005
Posts: 8255
Location: Maywood, IL

PostPosted: Tue Sep 01, 2009 8:20 am    Post subject: Reply with quote

Sort should say wrote:
U: (snip) If the either Random or Foptions are in effect, duplicates are removed only if they appear adjacent to each other as a result of the sort. For example, when "A|B|A" is sorted randomly, the result could contain either one or two A's.



Topic
_________________

(Common Answers)
Back to top
View user's profile Send private message Visit poster's website
Chris
Site Admin


Joined: 02 Mar 2004
Posts: 10716

PostPosted: Sun Sep 20, 2009 10:56 pm    Post subject: Reply with quote

Thanks for all the corrections and suggestions. I have made almost all these changes, though a few I didn't apply because the current method seems slightly better.

Lexikos wrote:
WinActive() and WinExist() are often used to retrieve the ID of the active window. However, their sections in the documentation link to IfWinActive and IfWinExist, which do not mention "A". The following thread prompted my post: WinGetActiveID?.
I've added the missing text to IfWinExist, and also mentioned WinExist("A") in the WinActive() section. Thanks.

Lexikos wrote:
WinShow, WinWait, IfWin and variations - If DetectHiddenWindows is Off, WinWaitClose or WinWaitNotActive can be used to wait for a hidden window to become active, while WinWait or WinWaitActive can be used to wait for a visible window to become active. Similarly, IfWin can be used to determine whether the active window is visible. One common example of a hidden active window: whenever a popup menu is shown, the window which owns it is activated. AutoHotkey's menus and all other tray icon menus I've tested are owned by hidden windows.
I can see that mentioning WinTitle "A" in those sections would improve completeness and accuracy. However, since working with an active window that is hidden seems very rare, maybe mentioning "A" would be more distracting than it's worth. I'm not sure.

Crash&Burn wrote:
Can Rajat's updated messages.txt be added to the AutoHotkey.CHM?
Maybe it's best that the list omit really obscure messages that are unlikely to be used by any scripts, especially if there are dozens or hundreds of obscure messages currently missing. For the more common messages that are missing, if someone would like to update the current list, it is at www.autohotkey.com/docs/misc/SendMessageList.htm

Thanks again for all the corrections and improvements. More are welcome anytime.
Back to top
View user's profile Send private message Send e-mail
jaco0646



Joined: 07 Oct 2006
Posts: 3113
Location: MN, USA

PostPosted: Thu Sep 24, 2009 2:37 am    Post subject: Reply with quote

The documentation for A_EndChar notes that it only applies to non-auto-replace hotstrings. For consistency, A_ThisHotkey should have the same note.

EDIT: ...unless it's an easy fix to make, but that's an item for the Wish List. Smile
Back to top
View user's profile Send private message Visit poster's website
Display posts from previous:   
Reply to topic    AutoHotkey Community Forum Index -> Bug Reports All times are GMT
Goto page Previous  1, 2, 3, 4, 5, 6 ... 11, 12, 13  Next
Page 5 of 13

 
Jump to:  
You can post new topics in this forum
You can reply to topics in this forum


Powered by phpBB © 2001, 2005 phpBB Group