 |
Fang Xianfu
GURU
Joined: 26 Jan 2004
Posts: 5155
Location: United Kingdom
|
 Posted: Fri Apr 20, 2007 1:18 am
[1.28] Popup help tooltip examples don't match their descriptions.
|
When you type a function name and the opening bracket into the new Scintilla editor, a popup appears detailing the syntax for that function. Unfortunately, the names of the variables don't always match, for example:
| Quote: |
%pos(s,t)
Returns the position of substring P in string S. Returns 0/false if not found. |
The description talks about the strings P and S, whereas the example contains strings s and t. This is especially bad since P is s and S is t - it could easily mislead.
The help for other functions isn't very helpful in that it doesn't mention the single-letter names from the example at all:
| Quote: |
%ismember(s,t)
Determine if an element is a member of a list. Returns 0 (false) if the item is not contained in the list, otherwise returns the item number that is found. |
which doesn't explain at all what s and t actually mean. It's relatively minor given that more detailed help is easily accessible with the new F1 functionality, but I think that one of the major uses for these popups is as a reminder of the exact syntax, and as they stand, they don't do that. |
|
|
|
|
Zugg
MASTER
Joined: 25 Sep 2000
Posts: 23379
Location: Colorado, USA
|
Posted: Fri Apr 20, 2007 5:38 pm
|
Yep, I know about that. The current popup help is really just a placeholder. I need to add some additional fields to the database that contains the commands/functions to fix this, or somehow tie it to the data in the help database.
|
|
|
|
|
|
|
|
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
|
|
