PureBasic Docs - Errors & needed improvements to the man

Found an issue in the documentation ? Please report it here !

Moderator: Documentation Editors

Little John
Addict
Addict
Posts: 4527
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Chr()

Post by Little John »

Chr()

In the help of PB 4.40 Beta 3 it reads like this:
Text$ = Chr(ASCII-Value)
Returns the character associated with the given ASCII value.

Not a single word about Unicode there ...
But Chr() can also return Unicode characters (in unicode mode, if the source file is in UTF8 format). That's much appreciated and pretty cool, but before we can use it, we'll have to know about it. :-)
So mention it in the docs, please.

Regards, Little John
Little John
Addict
Addict
Posts: 4527
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

[PB 4.40 Beta 3] NewMap

Post by Little John »

NewMap

Although the help for NewMap() exists, the word "NewMap" does not appear in the help index. Also in the command index of Map(), the word "NewMap" is missing.

Another mistake:
In the beginning of the second paragraph of the English help for NewMap it reads
When using a new key for an affection, a new element is automatically added to the map.
"affection" doesn't make sense in this context. In the German help, it correctly reads "Zuweisung" here. This is "assignment" in English.

Regards, Little John
User avatar
Arctic Fox
Enthusiast
Enthusiast
Posts: 609
Joined: Sun Dec 21, 2008 5:02 pm
Location: Aarhus, Denmark

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Arctic Fox »

The link to TextureOutput() in StartDrawing() should be removed.
User avatar
Andre
PureBasic Team
PureBasic Team
Posts: 2058
Joined: Fri Apr 25, 2003 6:14 pm
Location: Germany (Saxony, Deutscheinsiedel)
Contact:

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Andre »

@Little John:

The spelling error in english 'NewMap' help was fixed, as well a false link to the 'LinkedList' library in the introduction of the 'Map' library. There is also a link to the 'NewMap' keyword already there.... and it's not listed in the command-list of this library just because it's a keyword and not a command of this library.

The other issues I've set on the 'ToDo' list - see first post...
Bye,
...André
(PureBasicTeam::Docs & Support - PureArea.net | Order:: PureBasic | PureVisionXP)
User avatar
Andre
PureBasic Team
PureBasic Team
Posts: 2058
Joined: Fri Apr 25, 2003 6:14 pm
Location: Germany (Saxony, Deutscheinsiedel)
Contact:

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Andre »

Arctic Fox wrote:The link to TextureOutput() in StartDrawing() should be removed.
Done.
Bye,
...André
(PureBasicTeam::Docs & Support - PureArea.net | Order:: PureBasic | PureVisionXP)
Little John
Addict
Addict
Posts: 4527
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Little John »

Thank you, Andre!

Regards, Little John
Seymour Clufley
Addict
Addict
Posts: 1233
Joined: Wed Feb 28, 2007 9:13 am
Location: London

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Seymour Clufley »

I'm using beta5 and the CHM has no documentation of the new 2D Drawing commands, drawing modes, etc.
JACK WEBB: "Coding in C is like sculpting a statue using only sandpaper. You can do it, but the result wouldn't be any better. So why bother? Just use the right tools and get the job done."
User avatar
blueb
Addict
Addict
Posts: 1044
Joined: Sat Apr 26, 2003 2:15 pm
Location: Cuernavaca, Mexico

Re: PureBasic Docs - Errors & needed improvements to the man

Post by blueb »

It would be helpful if the manual explained the For:Next command a little better..

e.g. Stepping and negative stepping for example.

Code: Select all

k = 10
For k = 10 To 1 Step -1
    Debug k
Next
--blueb
- It was too lonely at the top.

System : PB 6.10 LTS (x64) and Win Pro 11 (x64)
Hardware: AMD Ryzen 9 5900X w/64 gigs Ram, AMD RX 6950 XT Graphics w/16gigs Mem
User avatar
Andre
PureBasic Team
PureBasic Team
Posts: 2058
Joined: Fri Apr 25, 2003 6:14 pm
Location: Germany (Saxony, Deutscheinsiedel)
Contact:

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Andre »

blueb wrote:It would be helpful if the manual explained the For:Next command a little better..

e.g. Stepping and negative stepping for example.

Code: Select all

k = 10
For k = 10 To 1 Step -1
    Debug k
Next
Done :D

Seymour Clufley wrote:I'm using beta5 and the CHM has no documentation of the new 2D Drawing commands, drawing modes, etc.
Set on ToDo list for Fred/freak.
Bye,
...André
(PureBasicTeam::Docs & Support - PureArea.net | Order:: PureBasic | PureVisionXP)
Little John
Addict
Addict
Posts: 4527
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Little John »

FillArea()

Currently the Reference Manual writes:
If the 'BorderColor' parameter is set to -1, then the area defined by the color found at the (x,y) coordinates will be filled.
IMHO this hardly describes the effect of -1 in this context.

I think it should read something like this:
If the 'BorderColor' parameter is set to -1, then any color that is different from the color at point (x,y) will be treated as 'BorderColor'.
Regards, Little John
infratec
Always Here
Always Here
Posts: 6874
Joined: Sun Sep 07, 2008 12:45 pm
Location: Germany

Re: PureBasic Docs - Errors & needed improvements to the man

Post by infratec »

Hi,

DatabaseUpdate() needs an update!

At the weekend I was fighting for ours with SQLite and the example in the (german) help.

Code: Select all

  ; Zuerst stellen wir eine Verbindung zu der 'employee' (Angestellten) Tabelle her
  ;
  If DatabaseQuery(#Datenbank, "SELECT * FROM employee") ; Ermittelt alle Einträge in der 'employee' Tabelle
  
    While NextDatabaseRow(#Datenbank)   ; alle Einträge durchlaufen
      
      ; Aktualisieren des 'checked' Felds für jeden Eintrag, vorausgesetzt
      ; das 'id' Feld ist das erste in der 'employee' Tabelle
      ;
      DatabaseUpdate(#Datenbank, "UPDATE employee SET checked=1 WHERE id="+GetDatabaseString(#Datenbank, 0)) 
    Wend

    FinishDatabaseQuery(#Datenbank)
  EndIf
This example tells you, that it is possible to update each entry in the database inside the loop.
But it is not working.

There is already a posting about that, but nothing is changed.
http://www.purebasic.fr/english/viewtop ... te#p248148

So please change the helpfile, or if it is a bug with SQLite, write it inside this help.

Best regards,

Bernd
THCM
Enthusiast
Enthusiast
Posts: 276
Joined: Fri Apr 25, 2003 5:06 pm
Location: Gummersbach - Germany
Contact:

Re: PureBasic Docs - Errors & needed improvements to the man

Post by THCM »

Hi, it would be helpful to have a better explanation of the different screen output subsystems and which commands are supported by each subsystem. Also a compiler warning would be nice, if you try to use an unsupported command.
The Human Code Machine / Masters' Design Group
Little John
Addict
Addict
Posts: 4527
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Little John »

As I posted in the "Coding questions" section a few days ago, some example code in the current help regarding 2D drawing ( see e.g. Circle() ) does not work at all on Ubuntu.

Srod has confirmed my point of view and nobody objected, so I really think the example code is wrong, at least as far as Linux is concerned.
On Windows, the example code in the help does work, but srod wrote that in his opinion the modification that I posted (suggested by #Null on the German forum) is the safer one to use on all platforms.

Since it's important to have working example code, please change it for the 4.40 final release.

TIA, Little John
Seymour Clufley
Addict
Addict
Posts: 1233
Joined: Wed Feb 28, 2007 9:13 am
Location: London

Re: PureBasic Docs - Errors & needed improvements to the man

Post by Seymour Clufley »

Little John wrote:If the 'BorderColor' parameter is set to -1, then any color that is different from the color at point (x,y) will be treated as 'BorderColor'.
I strongly agree with this suggestion.
JACK WEBB: "Coding in C is like sculpting a statue using only sandpaper. You can do it, but the result wouldn't be any better. So why bother? Just use the right tools and get the job done."
User avatar
nco2k
Addict
Addict
Posts: 1344
Joined: Mon Sep 15, 2003 5:55 am

Re: PureBasic Docs - Errors & needed improvements to the man

Post by nco2k »

would be nice if you could re-arrange the value types table and keep .c at one place.

currently:
Byte
Ascii
Character
Word
Unicode
Character
Long
Integer
Integer
Float
Quad
Double
String
Fixed String
better:
Byte
Ascii
Word
Unicode
Character
Character
Long
Quad
Integer
Integer
Float
Double
String
Fixed String
btw, why isnt there a default (.i like) type for floats? .f on 32bit and .d on 64bit. isnt .d 'faster' on 64bit?

c ya,
nco2k
If OSVersion() = #PB_OS_Windows_ME : End : EndIf
Locked