Page 13 of 15
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Mon Sep 26, 2011 1:49 am
by netmaestro
Currently the new commands RandomizeArray() and RandomizeList() appear in the command index under "Sort" in the manual. This is good but I think they should also appear in the command index for their respective objects, "Array" and "Linked List" as they are commands that work exclusively with those objects. I looked for them there first and I imagine others might as well.
(very useful additions, btw)
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Fri Sep 30, 2011 7:44 am
by infratec
Hi,
during looking after windows bugs, I discovered that CreateCube() is not mentioned in the
help (4.60RC1 german helpfile).
And CreateMesh() has one parameter to much in the help.
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Mon Oct 03, 2011 11:07 pm
by luis
PB4.60 RC1
PokeS()
Text$ is missing from the parameters listed inside the table.
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Sun Oct 23, 2011 10:59 pm
by luis
PB 4.60 RC2
ReplaceString
1) The help doesn't mention what the return value is.
You have to deduce looking and trying the examples it is a copy of the source string modified by the replace operation.
2) The examples in the help are using numeric constants instead of the symbolic constants #PB_String_*, so again one is guessing what is what, and you have to check the numerical value of the constants to know for sure.
http://www.purebasic.fr/english/viewtop ... =4&t=47882
EDIT: in the 4.60 final too.
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Wed Nov 02, 2011 1:22 am
by Arctic Fox
A mention of #PB_GadgetType_Canvas is missing (GadgetType, constants overview etc.).
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Fri Nov 25, 2011 12:21 am
by luis
PB 4.60 final
NextMapElement
ReturnValue is listed inside the table with a @ in front of it. It should be outside (like Example).
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Fri Dec 02, 2011 7:30 pm
by Andre
Fixed for next version (topics from this side of the thread):
- NextMapElement -> Returnvalue
- GadgetType -> CanvasGadget
- ReplaceString -> Return value
- RemoveString -> using PB constant instead of value
- RandomizeArray/List --> several more links/mentions were added in the manual to find this new functions easier
Things, which should already be fine with PB 4.60 final:
- CreateCube
Up to Fred, who must check if an error in the docs or a missing feature of the command:
- CreateMesh -> second parameter
- and of course the first topic in this thread with collected suggestions!
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Sun Dec 04, 2011 3:03 pm
by Shardik
Andre,
unfortunately you seem to have forgotten to add a remark to each
Gadget description in the help for which the SetGadgetColor() and
SetGadgetItemColor() commands on the
Mac don't work (in contrast
to the Windows and Linux version). Do you remember my fancy
table
which lists all non-working color commands on the Mac? freak
decided that a remark should have been added to each Gadget
description which doesn't work with color commands on the Mac:
freak wrote:Don't add that table. Add a note in the topic for each function instead.
There has already been again an unnecessary
bug report of a new
user which could have been prevented by changing the documentation
as freak had proposed. It would be nice if you could add the necessary
notes in the help for PB 4.61...
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Sun Dec 11, 2011 12:21 am
by luis
PB 4.60
I think the manual should explain residents.
They are only mentioned in the compiler options, but there is no explanation on what they are, what you can put into a resident and what you can't, and what you can use them for.
ScaleMaterial is missing in the Docs
Posted: Fri Dec 16, 2011 8:36 pm
by Thade
Under Material
ScrollMaterial and RotateMaterial are listed and explained
ScaleMaterial is not in the docs. But it exists.
[Note by Andre on 11th Oct. 2012: fixed in PB5.00 b4]
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Wed Dec 21, 2011 12:15 pm
by Trond
In the IDE: F1 on ArraySize() leads to the page of Dim instead of ArraySize().
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Fri Dec 30, 2011 3:50 pm
by luis
Asc()
Please add a note in the manual explaining it works with unicode too (and replace chain with string).
see:
http://www.purebasic.fr/english/viewtop ... 21#p370521
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Fri Jan 06, 2012 5:29 pm
by Demivec
PathRequester() specifies its syntax as:
Code: Select all
Filename$ = PathRequester(Title$, InitialPath$)
It would make more sense if this was changed to:
Code: Select all
Path$ = PathRequester(Title$, InitialPath$)
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Sun Jan 15, 2012 1:34 am
by Arctic Fox
Help: OffsetOf wrote:... When used with an Interface, the function index is the memory offset, so it will be IndexOfTheFunction*4.
On 64-bit it is IndexOfTheFunction*8. This goes for the example, too. Pointers are 4 bytes on 32-bit and 8 bytes on 64-bit.
Code: Select all
Structure Person
Name.s
ForName.s
Age.w
EndStructure
Debug OffsetOf(Person\Age) ; will be 8 as a string is 4 byte in memory (16 on 64-bit)
Interface ITest
Create()
Destroy(Flags)
EndInterface
Debug OffsetOf(ITest\Destroy()) ; will be 4 (8 on 64-bit)
Re: PureBasic Docs - Errors & needed improvements to the man
Posted: Sun Jan 15, 2012 3:45 am
by Guimauve
[quote=Help - CreateTexture()]It's strongly recommended to make the texture square and with power of 2 width/height: 64x64, 128x128, 256x256... Old GFX cards can have limitation, so if possible limit the texture size to 256x256. [/quote]
Sorry but this is false, the texture can be rectangular :
16X256 --> Valid size
64X128 --> Valid size
128X256 --> Valid size
256X16 --> Valid size
128X64 --> Valid size
256X128 --> Valid size
Best regards.
Guimauve