Help File/Documentation Issues. (Discussion Only)

[BrewManNH]

I think the all UDF _Array* functions should note either in description or remarks if they are for 1 dimensional arrays.

Good point, most only mention the 1D part in the error message descriptions.

[AZJIO]

Added another option calculation

Local $nCos1, $nCos2, $nCos3, $nDegToRad, $nRadToDeg, $pi
$pi = 3.14159265358979 ; PI this semicircle expressed in radians
$nDegToRad = $pi / 180 ; 1 degree expressed in radians
$nRadToDeg = 180 / $pi ; 1 radian expressed in degrees, 57.2957795130824°

$nCos1 = Cos($pi / 4) ; the cosine of the angle 45°
$nCos2 = Cos(90 * $nDegToRad) ; the cosine of the angle 90°
$nCos3 = Cos(30 / $nRadToDeg) ; the cosine of the angle 30°

MsgBox(4096, 'the cosine of the angle 45°, 90° and 30°', _
        'Cos(pi / 4) =' & $nCos1 & @LF & _
        'Cos(90 * pi / 180) =' & $nCos2 & @LF & _
        'Cos(30 / (180 / pi)) =' & $nCos3)

$iCos1 --> $nCos1
$iDegToRad--> $nDegToRad

[mLipok]

I think the all UDF _Array* functions should note either in description or remarks if they are for 1 dimensional arrays.

good idea

small review:

in ArraySort:

good example in syntax description:

Sort a 1D or 2D array on a specific index using the dualpivotsort/quicksort/insertionsort algorithms.

 

in _ArrayToString

descripion only in Return Value

3 - $avArray is not an 1 dimensional array

syntax description

now:

Places the elements of an array into a single string, separated by the specified delimiter.

proposal:

Places the elements of an 1D array into a single string, separated by the specified delimiter.

 

I wonder if it would be sufficient in the description of the syntax, indicate the dimension of the array by specifying the type:

    1D array

    1D or 2D array

    xD array

 

EDIT:

eventualy "mulitD array" instead "xD array"

Edited December 17, 2013 by mlipok

[BrewManNH]

None of the Array functions work on anything more than a 2D array, no point in using multiD array as a description, it would cause much more confusion than clarity.

[guinness]

If issues have been reported here with no Trac number then they will not be in the next beta version of AutoIt. See first post for details.

[AZJIO]

Is it acceptable to use it in the examples?

Until Not Sleep(30)
Exit MsgBox(0, '', $sText)

[Exit]

Definitely NO ..... questionable Magic number   

[guinness]

Depends on the example.

[AZJIO]

Depends on the example.

 

_GDIPlus_GraphicsDrawClosedCurve2.au3

_GDIPlus_GraphicsDrawCurve2.au3

_GDIPlus_GraphicsFillClosedCurve2.au3

_GDIPlus_GraphicsSetPixelOffsetMode.au3

 

Random

Flag [optional] If this is set to 1 then an integer result will be returned. Default is a floating point number. 

By default the Random() function works with decimal/floating point numbers. If you want to return an integer/whole number result then set the Flag parameter to 1.

Information is duplicated twice

Edited December 19, 2013 by AZJIO

[AZJIO]

GUICtrlCreateAvi - GUICtrlCreateDate
BitOR/a>

GUI Control Styles

$LVS_EX_INFOTIP 0x00000400 Displays a tooltip when the item is not fully visible. Sends a notification message to $ LVN_GETINFOTIP

[guinness]

GUICtrlCreateAvi - GUICtrlCreateDate

BitOR/a>

GUI Control Styles

$LVS_EX_INFOTIP 0x00000400 Displays a tooltip when the item is not fully visible. Sends a notification message to $ LVN_GETINFOTIP

Done. Changed to Displays a tooltip when the item is not fully visible. Sends a notification message to $LVN_GETINFOTIP. Unless I am wrong, so in that case be specific.

I am unlikely to check this thread after the holidays. You have been warned.

[mLipok]

Why the text formatting is used (by me unnecessarily) character the end of the line.

For example, the documentation for the function: _WinAPI_FindTextDlg

 

 

Remarks The _WinAPI_FindText() does not perform a search operation. Instead, the dialog box sends FINDMSGSTRING registered{ENTER}
messages to the window procedure of the owner window of the dialog box.

Before calling _WinAPI_FindText(), you must call the _WinAPI_RegisterWindowMessage() function to get the identifier{ENTER}
for the FINDMSGSTRING message. The dialog box procedure uses this identifier to send messages when the user clicks the{ENTER}
"Find Next" button, or when the dialog box is closing. The "lParam" parameter of the FINDMSGSTRING message contains{ENTER}
a pointer to a $tagFINDREPLACE structure. The "Flags" member of this structure indicates the event that caused the{ENTER}
message. Other members of the structure indicate the user's input.

The _WinAPI_FindText() uses an internal buffer to hold the string that the user typed in the "Find What" edit controls.
You can increase the size of this buffer by using the _WinAPI_SetFRBuffer() function. In addition to free the memory{ENTER}
allocated for the internal buffer, you must call the _WinAPI_FlushFRBuffer() in response to the FINDMSGSTRING{ENTER}
message with $FR_DIALOGTERM flag set.

 

I propose:

 

Remarks

The _WinAPI_FindText() does not perform a search operation. Instead, the dialog box sends FINDMSGSTRING registered messages to the window procedure of the owner window of the dialog box.

 

Before calling _WinAPI_FindText(), you must call the _WinAPI_RegisterWindowMessage() function to get the identifier for the FINDMSGSTRING message.

The dialog box procedure uses this identifier to send messages when the user clicks the "Find Next" button, or when the dialog box is closing.

The "lParam" parameter of the FINDMSGSTRING message contains a pointer to a $tagFINDREPLACE structure. The "Flags" member of this structure indicates the event that caused the message.

Other members of the structure indicate the user's input.

 

The _WinAPI_FindText() uses an internal buffer to hold the string that the user typed in the "Find What" edit controls.

You can increase the size of this buffer by using the _WinAPI_SetFRBuffer() function. In addition to free the memory allocated for the internal buffer, you must call the _WinAPI_FlushFRBuffer() in response to the FINDMSGSTRING message with $FR_DIALOGTERM flag set.

 

 

Summary:

 

Currently, the formatting is applied to multiple files in both the "Remarks" and "Parameters" section.

 

As a result of this formatting when you try to change the window size of HelpFile, the text may look quite "messy" making it difficult to read and understand.

[guinness]

Fixed: Quite simple really.

[mLipok]

I know it's easy to change it.

But I mean a global, not just this one file (_WinAPI_FindTextDlg.txt).

 

That's why I wanted to draw attention to this problem, and obtain approval for the implementation of appropriate changes.

[guinness]

Can't be done. I mean how am I suppose to know what the end of a sentence is? A . (period) isn't a good indicator for this. These changes are best for human intervention mlipok.

Edited December 29, 2013 by guinness

[mLipok]

I am aware that not everything can be automated.

I know that here can not do without tedious work.

 

But I understand that there is acceptance of such changes.

[guinness]

The best that can be done is just to report it.

[guinness]

I think the all UDF _Array* functions should note either in description or remarks if they are for 1 dimensional arrays.

I thought they were clear already?

[mLipok]

 

I thought they were clear already?

 

as it turns out not completely

 

 

Good point, most only mention the 1D part in the error message descriptions.

 

 

in ArraySort:

good example in syntax description:

 

in _ArrayToString

descripion only in Return Value

 

the same situation (incomplete description) in 

_ArrayAdd

_ArrayCombinations

_ArrayConcatenate

_ArrayDelete

_ArrayInsert

_ArrayMaxIndex

_ArrayMinIndex

_ArrayPermute

_ArrayPop

_ArrayPush

_ArrayReverse

_ArrayToString

_ArrayTrim

 

absence of any description, in 

_ArrayMax

_ArrayMin

_ArraySwap

_ArrayToClip

 

another example >> good description:

_ArrayBinarySearch

_ArrayDisplay

_ArrayFindAll

_ArraySearch

_ArraySort

_ArrayTranspose

_ArrayUnique

[guinness]

So it's just a case of changing to the description to say "blah blah in a 1D and 2D array"?