Suggestions on documentation improvements

Propose new features and changes
joefiesta
Posts: 197
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Re: Suggestions on documentation improvements

09 Nov 2018, 12:16

I fully understand the issue now. In that case, let me restate my propoisition:

I feel the doc at IFMsgBox which states:
Known limitation: If the MsgBox contains only an OK button, the return value will indicate that the OK button was pressed if the MsgBox times out while its own thread is interrupted by another.
would be much clearer if it were worded something like:
Known limitation: If the MsgBox contains only an OK button, and it's thread is interrupted, and it times out during the interrupt, upon resumption of the thread the return value will indicate that the OK button was pressed.
lexikos
Posts: 6207
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Suggestions on documentation improvements

09 Nov 2018, 22:00

nnnik wrote:it will time out after the thread is resumed
Not so. In most cases, the MsgBox times out (the dialog is closed and the user can no longer read or interact with it) when the timeout period expires, regardless of whether the thread has been interrupted. If the timeout occurs before the thread is resumed, the return value will be "OK".

However, the timeout can be delayed by a long-running DllCall, file I/O calls, or anything else that prevents the program from pumping messages. Even if the timeout is delayed in this way, it might still occur before the thread is resumed.

Edit: The limitation will be removed in v1.1.30.01.
joefiesta
Posts: 197
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Dead link in doc

18 Nov 2018, 11:49

The documentation at "Gui Control types" at the description of the PICTURE control includes, in the "Animated Gif" paragraph a link to www.autohotkey.com/forum/topic19264.html, which redirects to:
https://autohotkey.com/board/topic/1772 ... -your-gui/.

At THAT site, there is a link labeled "Control_AniGif.ahk", which is: https://ahknet.autohotkey.com/~PhiLho/C ... AniGif.ahk

This is a DEAD LINK.

This is from offline doc 1.1.28.00. I see the current online doc does not have this problem. I haven't looked at 1.1.30.00 offline. (not there yet!)
ahk7
Posts: 124
Joined: 06 Nov 2013, 16:35

Re: Suggestions on documentation improvements

20 Nov 2018, 14:04

tmplinshi updated the code incl. dll here https://github.com/tmplinshi/AniGIF-AHK
guest3456
Posts: 2468
Joined: 09 Oct 2013, 10:31

Re: Suggestions on documentation improvements

20 Nov 2018, 14:24

does WinGet, ControlList[Hwnd] retrieve controls in order from topmost to bottommost, just like WinGet, List does for top level windows? and if so, shouldn't that be mentioned on the helppage too?

https://autohotkey.com/docs/commands/WinGet.htm

User avatar
Ragnar
Posts: 204
Joined: 30 Sep 2013, 15:25

Re: Suggestions on documentation improvements

20 Nov 2018, 19:11

guest3456 wrote:
20 Nov 2018, 14:24
does WinGet, ControlList[Hwnd] retrieve controls in order from topmost to bottommost, just like WinGet, List does for top level windows? and if so, shouldn't that be mentioned on the helppage too?
I'll add the following paragraph from v2's WinGetControls/WinGetControlsHwnd:
Controls are sorted according to their Z-order, which is usually the same order as the navigation order via Tab key if the window supports tabbing.
guest3456
Posts: 2468
Joined: 09 Oct 2013, 10:31

Re: Suggestions on documentation improvements

20 Nov 2018, 23:14

i'm not sure if it does retrieve the controls in Z-order, that's part of what i was asking

User avatar
Ragnar
Posts: 204
Joined: 30 Sep 2013, 15:25

Re: Suggestions on documentation improvements

21 Nov 2018, 04:42

It usually does. Internally, both WinGetControls/Hwnd and WinGet ControlList/Hwnd use the same function to retrieve the controls (EnumChildWindows). The only difference is the return value (array vs string list).
joefiesta
Posts: 197
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Re: Suggestions on documentation improvements

30 Nov 2018, 12:00

I disagree. I find the grammar confusing. There is NO GRAMMATICAL reason why the second sentence of the paragraph also relates to "Using the {key:value} notation..." of the first sentence.

I feel it would be much clearer if worded as:
Using the {key:value} notation:
1. quote marks are optional for keys which consist only of word characters.
2. Any expression can be used as a key, but to use a variable as a key, it must be enclosed in parentheses
Quite frankly, I find this kind of somewhat imprecise English grammar occurs fairly often in the AHK doc. But, no wants to accept any help to improve it. So, all I can do is point it out when I find it.
User avatar
nnnik
Posts: 3527
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Suggestions on documentation improvements

30 Nov 2018, 12:02

You could improve it on GitHub.
Recommends AHK Studio
joefiesta
Posts: 197
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Re: Suggestions on documentation improvements

30 Nov 2018, 12:11

really? WOW. I'm thrilled. I've long wanted to help with AHK in some way. The documentation is very, very good. The problem is: it is an EXTREMELY complicated language. But, if you were ever IBM mainframe documentation, you would think any other documentation sucks. Back in my mainframe days, if I wrote to IBM a comma was missing, they would fix it.

@nnnik: thanks a zillion!

Return to “Wish List”

Who is online

Users browsing this forum: No registered users and 6 guests