Page 1 of 1

Incoherence in manual (linked list lib)

Posted: Sat Apr 05, 2008 5:18 pm
by Psychophanta
ListIndex()

Syntax

Index = ListIndex(linkedlist())
SelectElement()

Syntax

SelectElement(LinkedList(), Position)
"Index" or "Position" :?:

I'd suggest 'PositionIndex'

Posted: Sat Apr 05, 2008 5:22 pm
by freak
:roll:

Posted: Sat Apr 05, 2008 8:31 pm
by Psychophanta
Hi,
what means :roll: ?

What i meant is that it causes confusion when reading manual because SelectElement() and ListIndex() functions are complementary, so the output parameter of ListIndex() should have the same name as the input one of SelectElement(). See the point? :roll:

Posted: Sat Apr 05, 2008 9:11 pm
by Fluid Byte
:roll: means that you are very pedantic here and it's only demo syntax. If you like you can call the variable 'poophead', who cares? The result is the same.

Posted: Sat Apr 05, 2008 9:17 pm
by Psychophanta
For example Fluid Byte does not get the point, even it is very simple: It causes confusion in the manual.
Some one gets the point in this simple and very easy to understand thing?

Posted: Sat Apr 05, 2008 10:07 pm
by Kaeru Gaman
I agree to Psychophanta, though I find 'PositionIndex' a bit oversized.
setting both to "Index" would do it and would be correct.

@freak

so, :roll: = "thanx for reporting a typo"? ;)

Posted: Sat Apr 05, 2008 10:15 pm
by Fluid Byte
Psychophanta, you got too much time on your hands ...

You talk about "confusion" and suggest "'PositionIndex'"? :roll:

@Kaeru:

He didn't reported a typo. The words are both written correctly.

Posted: Sat Apr 05, 2008 10:22 pm
by Kaeru Gaman
when you type "position" instead of "index" by accident, it's a "typo"... :mrgreen:

Posted: Sun Apr 06, 2008 1:56 pm
by Psychophanta
Yeah! you must decide a unique word (not 2 or more) to design a unique thing.
Kaeru is able to understand this easy-to-understand matter.
And yes, agree that 'Index' is better than 'Position' because this one can be easely confused with mem position. 8)

Fluid Byte needs more time to understand it, may be more than 100 years. :wink: