Report Help file errors here (Part 2)

[mLipok]

in Binary, IsArray, IsFloat, IsInt, IsString, IsNumber, IsBool, IsHWnd, Binary, BinaryToString, StringToBinary, VarGetType

I propose to add to Remarks link to "Language Reference - Datatypes"

[mLipok]

in Log

in Return Value

  Quote

Tends to return -1.#IND for non-positive parameters.

 

Again, please explain the importance of recording / phrase "#IND" in this context, "Tends to return -1. #IND for non-positive parameters"

 

Maybe I'm picky, but unfortunately not quite understand this type of description / wording.

It is thus possible that for others it is not clear.

[FireFox]

  On 8/16/2013 at 10:12 PM, mlipok said:

In my case (HelpFIle v3.3.9.17 (Beta)), everything works well, both when I search in index PixelCoordMode and AutoItSetOption

But I can not understand something?

Forget this, issue fixed in the beta helpfile.

[FireFox]

  On 8/16/2013 at 10:24 PM, mlipok said:

Again, please explain the importance of recording / phrase "#IND" in this context, "Tends to return -1. #IND for non-positive parameters"

 

Maybe I'm picky, but unfortunately not quite understand this type of description / wording.

It is thus possible that for others it is not clear.

If you want to use the function, and because it's a maths function, it's better to already know how it works.

You will see here that this function is defined between ]0, +infinity[ thanks to the graphic from this page.

So #IND means undefined or infinity.

Edited August 16, 2013 by FireFox

[mLipok]

Thanks for the clarification.

By the way, I like math.

[FireFox]

  On 8/16/2013 at 10:19 PM, mlipok said:

in Binary, IsArray, IsFloat, IsInt, IsString, IsNumber, IsBool, IsHWnd, Binary, BinaryToString, StringToBinary, VarGetType

I propose to add to Remarks link to "Language Reference - Datatypes"

Done (not for BinaryToString, StringToBinary).

[mLipok]

My observations:

 

In HelpFile the index: I search Dim Local Global Const

Always opens the same page documentation: "Dim / Global / Local / Const"

 

It seems that everything is OK.

 

After one of the order opening the site started something did not fit.

 

This page dossier at first glance looks like a description of only one keyword "Dim"

Why do I think so.

It's simple - at the top of the "yellow box" keywords are not used Local Global Const.

 

The rest of it is true is the description that begins with "The difference between Dim, Local and Global is the scope in Which they are created," but it is already in the middle of the page and you can not see it right away.

 

Please, take a look at this part of the documentation with particular emphasis on topics like "Best coding practice"

Edited August 16, 2013 by mlipok

[FireFox]

huh, they are all redirecting to the Dim page, I don't know how the redirections works so I will ask for it.

And indeed, it does not reflect the good coding practices, and it would be better to introduce them in the help file, I mean bad practices shouldn't be there.

Yet, it's an old helpfile page.

[guinness]

I just checked the updates, nice work FireFox.

I will say this though be careful when linking to functions in UDFs and vice versa, for example in _Degree() you were linking to Sin() in the same folder, but this is located in the folder "functions." Therefore it should have been ..functionsSin.htm. Same can be said for links to datatypes which I'm really not understanding why they should be added.

Do you want me to fix what has been done?

Also currently it's not recommended to link to UDFs in native functions and vice versa. I can explain more in private if you want about this.

[FireFox]

  On 8/16/2013 at 11:50 PM, guinness said:

I just checked the updates, nice work FireFox.

 

I will say this though be careful when linking to functions in UDFs and vice versa, for example in _Degree() you were linking to Sin() in the same folder, but this is located in the folder "functions." Therefore it should have been ..functionsSin.htm. Same can be said for links to datatypes which I'm really not understanding why they should be added.

I had some doubts about the links and you pointed out my thoughts.

Edit2: I thought it was right to add them since the IsSomething is related to a variable type.

  On 8/16/2013 at 11:50 PM, guinness said:

Do you want me to fix what has been done?

Yes please.

 

  On 8/16/2013 at 11:50 PM, guinness said:

Also currently it's not recommended to link to UDFs in native functions and vice versa. I can explain more in private if you want about this.

I can guess the answer but I'm listening to you

Edit: I can revert some changes, that's not because I did it that it means it's acceptable.

Edited August 16, 2013 by FireFox

[mLipok]

Ah you two.

You tricked me you were two and I was alone.

For this I believe Guinness had a nap.

[guinness]

I will fix what has been done, but I'm under the impression everything has been done up until this post. Also I noticed that you're not adding parentheses around a function name .e.g  <a href="Sin.htm">Sin()</a> not <a href="Sin.htm">Sin</a>().

I also don't understand why datatypes has been added to IsString etc... could some explain why?

OK, I left it.

Edited August 17, 2013 by guinness

[mLipok]

If I remember correctly it functions <Excel.au3> require MS Excel installed.

 

If I'm right, then I suggest to add in

_ExcelBookAttach, _ExcelBookNew, _ExcelBookOpen

 

in Remarks

a note of the need.

[guinness]

  On 8/16/2013 at 11:35 PM, mlipok said:

 

My observations:

 

In HelpFile the index: I search Dim Local Global Const

Always opens the same page documentation: "Dim / Global / Local / Const"

 

It seems that everything is OK.

 

After one of the order opening the site started something did not fit.

 

This page dossier at first glance looks like a description of only one keyword "Dim"

Why do I think so.

It's simple - at the top of the "yellow box" keywords are not used Local Global Const.

 

The rest of it is true is the description that begins with "The difference between Dim, Local and Global is the scope in Which they are created," but it is already in the middle of the page and you can not see it right away.

 

Please, take a look at this part of the documentation with particular emphasis on topics like "Best coding practice"

 

I discussed with jpm about this 7 months ago. It's something we're working on, so please be patient.

[guinness]

  On 8/17/2013 at 12:12 AM, mlipok said:

 

If I remember correctly it functions <Excel.au3> require MS Excel installed.

 

If I'm right, then I suggest to add in

_ExcelBookAttach, _ExcelBookNew, _ExcelBookOpen

 

in Remarks

a note of the need.

 

Yes, but so far this hasn't been an issue.

[guinness]

  On 8/16/2013 at 9:42 PM, mlipok said:

 

I know what I wanted to propose here.

in AutoItSetOption

in Remarks

The options are described in the table.

So please first look at the description of the "WinTitleMatchMode"

As you can see contains a description of "see Window Titles & Text (Advanced)"

 

In my previous posts, I had proposed to the description option "MustDeclareVars" add an additional line "See description for variable declarations," and here I offered a link to "Dim / Global / Local / Const"

 

I think now that I explained my idea, as far as I could.

 

Done.

[mLipok]

  On 8/17/2013 at 12:12 AM, guinness said:

I also don't understand why datatypes has been added to IsString etc... could some explain why?

 

It was my idea, so I'll try to convey my thoughts in this regard.

 

I check the group al IsSomeDataType

  Quote

isNumber

A number can be an integer / whole number or a fractional / floating-point.

If the variable is a numeric value Represented as a string, then ISNUMBER () will return 0

 

IsArray:

Can be useful to validate array / non-array parameters are user-defined functions.

 

isint

Isint (7.5 - 2.5) returns 1 (meaning true).

 

IsFloat:

See the examples.

 

IsString:

None.

 

IsBool

there is nothing

 

IsHWnd

there is nothing

 

 

 

 

I looked, compared, in principle, are functions of the same kind.

Check the data type.

So I ask you (like I did not know)

1 what is "DataType"

2 what are the types of data

3 which combines these functions.

 

All the answers are in the "Language Reference - Datatypes"

 

So I do not know how to FireFox added the relevant links in the Remarks, but I still think that the idea of ​​adding the link to the documentation is good.

[guinness]

  On 8/16/2013 at 5:10 PM, AZJIO said:

Maybe we should post a topic about the compiler help file?

1. Need to do so that the compiler was multilingual. All texts were inserted at the beginning of the script

2. Need to do so that the compiler contain all of the necessary files. Then the other parties could do the optional plug-ins. For example you set the check box to make the description of a highlighter and the other does not set this flag.

3. Need to make to the color theme can be changed to black. About 20% are using a black theme to eyes do not get tired.

Feel free to create a new topic.

[mLipok]

  On 8/17/2013 at 12:17 AM, guinness said:

I discussed with jpm about this 7 months ago. It's something we're working on, so please be patient.

good to know, so I'll sit and wait

[guinness]

  On 8/17/2013 at 12:27 AM, mlipok said:

good to know, so I'll sit and wait

It's not as simple as find/replace. Dim is still valid, but its usage is of course questionable.