Incoherence in manual (linked list lib)

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
User avatar
Psychophanta
Always Here
Always Here
Posts: 5153
Joined: Wed Jun 11, 2003 9:33 pm
Location: Anare
Contact:

Incoherence in manual (linked list lib)

Post by Psychophanta »

ListIndex()

Syntax

Index = ListIndex(linkedlist())
SelectElement()

Syntax

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

I'd suggest 'PositionIndex'
http://www.zeitgeistmovie.com

while (world==business) world+=mafia;
freak
PureBasic Team
PureBasic Team
Posts: 5940
Joined: Fri Apr 25, 2003 5:21 pm
Location: Germany

Post by freak »

:roll:
quidquid Latine dictum sit altum videtur
User avatar
Psychophanta
Always Here
Always Here
Posts: 5153
Joined: Wed Jun 11, 2003 9:33 pm
Location: Anare
Contact:

Post 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:
http://www.zeitgeistmovie.com

while (world==business) world+=mafia;
User avatar
Fluid Byte
Addict
Addict
Posts: 2336
Joined: Fri Jul 21, 2006 4:41 am
Location: Berlin, Germany

Post 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.
Windows 10 Pro, 64-Bit / Whose Hoff is it anyway?
User avatar
Psychophanta
Always Here
Always Here
Posts: 5153
Joined: Wed Jun 11, 2003 9:33 pm
Location: Anare
Contact:

Post 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?
http://www.zeitgeistmovie.com

while (world==business) world+=mafia;
User avatar
Kaeru Gaman
Addict
Addict
Posts: 4826
Joined: Sun Mar 19, 2006 1:57 pm
Location: Germany

Post 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"? ;)
oh... and have a nice day.
User avatar
Fluid Byte
Addict
Addict
Posts: 2336
Joined: Fri Jul 21, 2006 4:41 am
Location: Berlin, Germany

Post 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.
Windows 10 Pro, 64-Bit / Whose Hoff is it anyway?
User avatar
Kaeru Gaman
Addict
Addict
Posts: 4826
Joined: Sun Mar 19, 2006 1:57 pm
Location: Germany

Post by Kaeru Gaman »

when you type "position" instead of "index" by accident, it's a "typo"... :mrgreen:
oh... and have a nice day.
User avatar
Psychophanta
Always Here
Always Here
Posts: 5153
Joined: Wed Jun 11, 2003 9:33 pm
Location: Anare
Contact:

Post 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:
http://www.zeitgeistmovie.com

while (world==business) world+=mafia;
Post Reply