Report Help File Issues Here

[Valik]

I don't give a fuck if you are William Shakespeare come back to life. That doesn't mean your English is perfect or that we are going to accept everything. This is especially true when I can be completely distracted and still spot problems with your "improvements" that don't actually improve the situation.

If you want to help and point out problems, that's great. If you are going to provide fixes, though, they need to be fixes and not just re-shuffling of problems. I don't have time to read through your previous post - aside from the note to me - bu in your first batch of fixes, as I pointed out, many of them didn't improve the situation.

[BrewManNH]

• "I promise you, once you have got the hang of such things you" should be changed to "I promise you that once you have got the hang of such things, you"

Shouldn't that be?

• "I promise you, once you have got the hang of such things you" should be changed to "I promise you that, once you have got the hang of such things, you"

[guinness]

rcmaehl,

Thanks. Just to note some of the errors you pointed out were already fixed in the latest Beta or didn't require any changing, but thanks for the noticing the spelling mistakes.

Bare in mind that I've now changed all instances of colour or adminstrator (for example) throughout the Help file.

[MvGulik]

SetError ( code [, extended [, return value]] )
SetExtended ( code [, return value] )

Mmm. Personally I find the use of the general word "code" kinda ambiguous.

Don't see whats wrong with

SetError ( error [, extended [, return value]] )
SetExtended ( extended [, return value] )

, or why/how the "code" version is/would be better.

[Valik]

It only accepts integers so it probably should reflect that. Integer or number would be appropriate although integer is more specific.

Actually I like what MvGulik said better. Unless you go with "error integer" and "extended integer" but that is a bit verbose.

Edited April 21, 2012 by Valik

[guinness]

I will change it to integer as that seems the most obvious to me.

[Valik]

The problem I have with "integer" is SetError() takes extended which is also an integer. There should also be consistency between what the extended value is for both functions. Whatever you call the first parameter for SetExtended() needs to be the same as the second for SetError(). Since SetError() has two parameters it can't really be "integer". That leaves us in a box where we really need to call them "error" and "extended" and then ensure we mention in the parameter descriptions that only integers are valid.

[jchd]

Wouldn't "errNum", "extNum" (or errorNum, extendedNum) be clear enough?

Explicitely adding in the notes that these are integers won't hurt anyway.

[Valik]

err_num and ext_num with a note in the description would work, too. I don't think we normally put a type specifier in the parameter name, though.

[Richard Robertson]

The help file is full of string parameter names being enclosed in double quotes. Isn't that a type specifier?

Well maybe not full of but I encountered at least several.

Edited April 22, 2012 by Richard Robertson

[water]

As all examples in the help file can be run by clicking on the "Open this Script" button and pressing F5 in SciTE I think they all should present a result to the user that shows how the function works.

Having that said I suggest to change the example for function "Round" from

Local $x = Round(-1.582, 1) ;returns -1.6
Local $y = Round(3.1415, 9) ;no change
Local $z = Round(123.5, -1) ;returns 120

to something like this:

ConsoleWrite("Round(-1.582, 1) returns: " & Round(-1.582, 1) & @CRLF) ; returns -1.6
ConsoleWrite("Round(3.1415, 9) returns: " & Round(3.1415, 9) & @CRLF) ; no change
ConsoleWrite("Round(123.5, -1) returns: " & Round(123.5, -1) & @CRLF) ; returns 120

And maybe a remark about possbile enexpected results when rounding floing point numbers as discussed

[Valik]

Do not assume the user uses an editor that captures stout. If examples should display output they should use a message box. Certain exceptions apply.

[water]

Agreed. I just would like to see examples that show how the functions etc. work without any additional editing.

[Valik]

So fix them? Or do you not have commit access?

[water]

Agreed. I have access but first I need to update my environment. At home I run Ubuntu and at my office where we use Windows 7 I'm not allowed to install software.

[guinness]

As mentioned before I'm in the process of updating the examples with better comments and displaying an output using MsgBox(4096... you can see I've already started, my next goal (this week) is to tackle the String functions, but if you can commit then that would help alot.

water,

I've already updated the Round example in the beta Help file.

Edited April 22, 2012 by guinness

[water]

Guinness,

thanks for updating the help file.

[guinness]

Guinness,

thanks for updating the help file.

No problem, I did the Round example back on the 25th January 2012.

[AZJIO]

water

without ConsoleWrite - VideoExample.exe (1 Mb)

[water]

Hi Azijio,

thanks for the video.

That's exactly what I was thinking about - an example should show how the function works without any additional coding by the user.