PureBasic Docs - Errors & needed improvements to the man

[Demivec]

It's recommended to get a slightly larger buffer, like 30% smaller to avoid overflows.

Fail, it should be 25% smaller.

Surely 25% larger?

No, read harder.

think!

... how can you avoid an overflow by using a smaller buffer?
... if only a smaller buffer was needed, how can using a bigger buffer produce an overflow?

surely, it should read "like 30% larger"

@Kaeru: the original poster left off a few important words. The quote from the help file is from the entry for Base64Decoder().

If one is using Base64Encoder() the buffer is larger, but if one is using Base64Decoder() the buffer is smaller It would appear that the entry in the manual for Base64Decoder() duplicated portions of the entry for Base64Encoder() but failed to adjust (i.e. replace 'larger' with 'smaller') it to match.

Since the original post four days ago, most of that has been corrected in the help file (though it still says 'overflows' which doesn't make since when it recommends a smaller buffer). The poster still thinks that the precision of the percentage difference of the buffers needs to be adjusted from 30-33% to 25%.


I am in agreement that the language should be adjusted. I'm not concerned about the percentage.

[infratec]

- Added graphical console functions to linux

If you mean

Code: Select all

EnableGraphicalConsole()
ConsoleLocate()

than you should add Linux to the 'Supported OS' in the helpfile.

[Seymour Clufley]

The help now has a specific section on Arrays.

IMHO it would be good to have a similar section for structures, then the structure commands could be taken out of the Compiler Functions section - I don't understand why they are in that section.

[skywalk]

Result = LoadImage(#Image, Filename$ [, Flags])

Help makes no mention of Flags to use?

Thanks,
Steve

[skywalk]

Hi,
I was looking for the VB6 equivalent of a Label that can have its text aligned and receive events.
The manual needs updating here...
Please add the mixing of String and Text Gadget Flags to create a ReadOnly StringGadget that has centered text and can trigger an event, unlike the TextGadget.

Code: Select all

If OpenWindow(0, 0, 0, 322, 220, "StringGadget - Centered & ReadOnly", #PB_Window_SystemMenu | #PB_Window_ScreenCentered)  
    StringGadget(5,10,55,75,24,"string5",#PB_Text_Center|#PB_String_ReadOnly)
    StringGadget(6,10,95,75,24,"string6",#PB_Text_Right|#PB_String_ReadOnly)
    TextGadget  (7,10,120,75,24,"text7",#PB_Text_Right|#PB_Text_Border)
    StringGadget(8,10,155,75,24,"string8",#PB_Text_Center|#PB_String_ReadOnly|#PB_Text_Border)  ;<--- However, this actually removes the border.
      Repeat
        If EventGadget() = 5
          If EventType() = #PB_EventType_Focus
            Debug "Focus on StringGadget #5"
          EndIf
        EndIf
      Until WaitWindowEvent() = #PB_Event_CloseWindow
  EndIf

'Flags' are always optional and can be composed (using the '|' OR operator) of one of the following constants:
#PB_String_Numeric : Only (positive) integer numbers are accepted.
#PB_String_Password : Password mode, displaying only '*' instead of normal characters.
#PB_String_ReadOnly : Read only mode. No text can be entered.
#PB_String_LowerCase : All characters are converted to lower case automatically.
#PB_String_UpperCase : All characters are converted to upper case automatically.
#PB_String_BorderLess : No borders are drawn around the gadget.

#PB_Text_Center : The text is centered in the gadget.
#PB_Text_Right : The text is right aligned.
#PB_Text_Border : A sunken border is drawn around the gadget. ;<--- However, this removes the border in a StringGadget.

[Vera]

Just a small typo - but still not fully unseeable

The indent is important here for a good lisibility

-> The indent is important here for a good visibility.

greetings ~ Vera

[zxtunes.com]

I have written the utility which checks links to pages in HELP and have found an error in a file
"pbconstants.html" - <a href =./gadget/.html> Gadget </a>
^^^
and

<a href=../xml/.html>XML</a>



other bugs:

page SortStructuredList():
"<a href=../reference/linkedlist.html>list</a>" - "linkedlist.html" file no exist

and

page AbortFTPFile():
"<a href="receiveftpfi.html">" - "receiveftpfi.html file no exist and
...<a href="sendftpfi.html">SendFTPFile</a>

and

page Array have:
"<a href="../Examples/Array.pb.html">Array.pb</a>" - file no exist

and

page Map: not found "Map.pb"

and

page Sort: not found "Sort (Numeric).pb" & "Sort (String).pb"


Fixed please.

[zxtunes.com]

and BoxedGradient() have strange line "@newline"...

[zxtunes.com]

and ";-------------------------------------------------------------------------------------------------------- " trash in "Clipboard"

[Trond]

- Typing ArraySize() and pressing F1 leads to the wrong manual page (Array instead of ArraySize()).
- #PB_GadgetType_Shortcut is missing.

[Arctic Fox]

The help says that ATan2(x, y) is calculated as ATan(x/y) - I am very sure that it is ATan(y/x), y over x.

Code: Select all

Debug ATan2(8, 10)
Debug ATan(8 / 10)
Debug ATan(10 / 8)

[zxtunes.com]

English HELP:

WebGadget:

Code: Select all

#PB_Web_ScrollX       : Get the horizontal scrolling position.
#PB_Web_ScrollYґ 

^^ Bug symbol

[done]

[Trond]

F1 on NextElement() in the IDE opens a "This program cannot display the webpage" page. 4.50 RC 1.

[skywalk]

Please explain ByRef handling of string variables in the Manual!

I was annoyed / stumped by the ByRef behavior for Strings in PureBasic.
From searching forum and trying different approaches, there are several ways:

http://www.purebasic.fr/english/viewtop ... 27#p327127

[GG]

Sorry if this error is already mentioned, but for DatabaseUpdate() in chm help file (databaseupdate.html) , the example doesn't mention 2 param, only one (the db handler is ommitted).

DatabaseUpdate("UPDATE employee SET checked=1 WHERE id="+GetDatabaseString(#Database, 0))

That would be corrected as :

DatabaseUpdate(#database,"UPDATE employee SET checked=1 WHERE id="+GetDatabaseString(#Database, 0))

In the french .chm help file,
- AddCipherBuffer(), StartAESCipher(), GetXMLStandalone(), FinishDatabaseQuery(), AESEncoder() and AESDecoder() description are in english.
- Same thing for "Compilation d'un programme" (ide_compiler.html), from "Enable Debugger" paragraph to "constantes" paragraph.
- Same thing for "Compilation d'un programme" (ide_compiler.html), for "Constantes personnalisées" paragraph.
- In "les outils externes" (PureBasic.chm::/Reference/ide_externaltools.html), the "Enable Tool on a per-source basis" paragraph is in english.
- In "Utiliser le debugger" page (PureBasic.chm::/Reference/ide_debugger.html), the following sentence is in english : "The code view also provides the mouse-over feature from the integrated debugger to quickly view the content of a variable.".

These small errors are still present in 4.50.