PureBasic Docs - Errors & needed improvements to the man

[Comtois]

Mod() is not in the doc

[Vera]

moved posting

Just found one (small) problem, but maybe some more could be added to this thread

PB4.50 German
• Page "Anpassen der IDE": pictures missing below "Editor - Einrückung" and "Compiler"

[PB]

The manual for MovieStatus() says:

Note: Be careful with this function when using sounds (e.g. MP3) as no pictures (frames) exist.

This warning now seems to be obsolete, because MovieStatus() works
for MP3s and returns 0 when the MP3 has finished playing. See here:

http://www.purebasic.fr/english/viewtop ... 13&t=32020

[Vera]

Font.pb - example is 'corrupt'

since PB 4.41 the DrawText doesn't show anymore because for StartDrawing() the front color has been set to white and transparent mode is turned on.

So a white background color parameter for the BOX is obsolete (except to overwrite the default black background of all objects)

Now - any object is white => the box-area is white , => the text is white while his background is removed

Quickest solution : remove the transparent mode or (nicer) change the box color

greetings ~ Vera

[Marco2007]

http://purebasic.com/documentation/data ... eblob.html

Code: Select all

GetDatabaseBlob(#Database, Column, *buffer, bufferlength)

[blueznl]

Minor thing from the help file:

Example: Array as procedure parameter

Procedure fill(Array A.l(1), length) ; the 1 stays for the number of dimensions of (?) the array

The 1 stands for...

or perhaps better, dunno

The 1 represents the number of dimensions in the array

But I'm not a native English speaker either, so...

[Vera]

4.51rc2
Typo: en + de
Examples/Console.pb.html : End?

Missing image:(en)
Reference/images : vdesigner-about.png

Typo: (en)
cipher/aesencoder.html:
Its size depends of the 'Bits' parameter: l6 bytes for 128 bit

Typo: (de)
MainGuide/history.html
IDE/Debugger:
Hinzugefügt: Einrücknugs-Hilfslinien und Leerzeichen-Optionen

LINUX (win?)
DisplaySprite3D() isn't displayed as quick-help, (although it's available via F1)

greetings ~ Vera

[PMV]

Please write down, what standard you are using in PB in the wrongly called "ASCII-Mode".
I mean "Windows-1252", so if some one want to convert the characters from ASCII-Mode
to use it in Unicode-Mode, he can find easily something like this:
http://en.wikipedia.org/wiki/Windows-1252

Otherwise there will be much more people with problems like this:
http://www.purebasic.fr/english/viewtop ... 74#p332374


And yes, i had the same problem for ages ago.

MFG PMV

[srod]

Base64Decoder().

The output buffer can be up to 33% smaller than the input buffer, with a minimum size of 64 bytes. It's recommended to get a slightly larger buffer, like 30% smaller to avoid overflows.

Should the 33% not be 25% ?

When encoding then yes you require a buffer 33% in excess of the size of the source buffer. When you reverse this, however, then to my reckoning we are talking about a max of 25% smaller.

[helpy]

==> http://en.wikipedia.org/wiki/Base64:[quote]Note that given an input of n bytes, the output will be (n + 2 - ((n + 2) % 3)) / 3 * 4 bytes long, which converges to n * 4 / 3 or 1.33333n for large n.[/quote]

[srod]

That is for encoding, not decoding.

Base-64 works by taking 3-bytes (24-bits) and encoding them in lots of 6-bits - thus creating 4 bytes. This gives a 33 and 1/3% increase.

Decoding does the opposite and thus reduces the buffer by at least 25%.

[c4s]

English help file for Frame3DGadget():
A note is missing, that SetGadgetText() can be used to change the frame Text$.

[Little John]

Base-64 works by taking 3-bytes (24-bits) and encoding them in lots of 6-bits - thus creating 4 bytes. This gives a 33 and 1/3% increase.

Decoding does the opposite and thus reduces the buffer by at least 25%.

That's absolutely correct:
1 byte increase for every 3 bytes is 1/3 = 33.333...% increase. And 3 bytes + 1 byte increase = 4 bytes.
1 byte decrease for every 4 bytes is 1/4 = 25% decrease (the denominator now is 4, not 3 anymore!).

This mistake in the help is pretty typical when people do percentage calculation.

Regards, Little John

[Demivec]

The RemoveString() and ReplaceString() commands of the string library need a description of what value to use for the default search mode when specifying a StartPosition. Alternate search modes have constants defined and explained in the help file entries but a person is left to guess what to use when the default search mode is desired while also specifying a StartPosition parameter.

[c4s]

FontRequester()

Flag parameter text:
The 'Flag' parameter isn't optional. I mean flags are always optional so it should be the same here?!

Color parameter text:
Just a small note but maybe this way it's a bit better: "You can get a valid color value with the RGB() function".
(instead of: "A valid color value you can get with the function RGB().")