Website and Help Typos

[admin]

Well, using variables to refer to strings is pretty much programming 101. I don't think there needs to be an example. The help file is fat enough.

[altoclef]

cataloglocation() is missing its return entry.

[admin]

[altoclef]

formatlist()

Format f also supports inversion by a prefixed "!".

The later examples show that inversion can also be applied to format F, but that is not stated in this statement or elsewhere.

[admin]

Ok.

[altoclef]

Please could you update the documentation for getkey() to include the return_on_error argument that you refer to here:

viewtopic.php?p=208279#p208279

[admin]

[eil]

Not a typo or a huge thing, but would be useful to edit Inputselect() command's description with the note for style 512, just like style 128 has one.

Code: Select all

Note: Cannot be combined with styles 2 and 32768, 
cause returns All items, no matter checked/un-checked/selected states.

That "conflict" is really not obvious, and it's easy to think 512 returns items taking in account other styles effects.(since no constrains mentioned )

A tiny wish for get() command's page to get own list of tags(just like main reference), since it has so many parameters that already took an own page.

[admin]

I think it's wrong as it is now. Checkboxes should override 512 because it's totally expected that only the checked items are returned.

I'm inclined to change it like this:

Code: Select all

    * SC inputselect: When flags 2 (checkboxes) and 512 (return all) were combined, 512 
      won, but this is counter-expectative. Fixed: Now 2 wins.

Apart from that I think it's quite obvious that both flags are in conflict and that it doesn't make sense to combine them.

[eil]

Apart from that I think it's quite obvious that both flags are in conflict and that it doesn't make sense to combine them.

Can't fully agree to that, cause for "new scripters" it kinda looks like this: you wanna icons - add style 1; wanna checkboxes - add 2; wanna re-order - add 16, need all pre-check - add 32768 = everything has a small bit of combination that Must be added, plus some few have notes that can't work together. And here we have only a Single style 512 among other bits, that states "returns all items in their current state". The note mentions that "otherwise you'll get vanilla listdata" = which for "new scripter" means "all the changes i did with checks or re-order, won't be returned without that style, so it's a Must when changes were done to list".

Just for another example. Recently i spent half an hour in experiments trying to understand why couldn't i make inputselect() to take a PNG as an icon = it has 1024 style, comprehends caption|data|icon, so what's wrong?! The reason is simple - i got used that in popupmenu() PNG is valid, in user buttons too, so even after checking style 1024 description section i wasn't right away sure. True, it doesn't state anything about picture-icons, but at the same time there is no strict "only ICO, EXE, DLL", so i first expected "it should work just like popupmenu(), probably it's something wrong with my code".
That's how not obvious it can be.

[admin]

Of course, you could always add more sentences to a 900-page help file. But why rob new scripters of the joy of discovery? Scripting is an adventure!

Did you test the new logic in v28.40.0615?

[eil]

Well, to add couple sentences or keep getting same question cause Help leads to wall, that's a choice too.

Can't check new logic - my laptop died and for now i'm stuck with old single core/x86 thing. But i'm sure it works flawlessly as all Don-tech.