Command summaries in the Indeces

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
User avatar
Tenaja
Addict
Addict
Posts: 1959
Joined: Tue Nov 09, 2010 10:15 pm

Command summaries in the Indeces

Post by Tenaja »

Instead of a mere list of links to commands, it would be helpful to newbies to have a brief summary of the command. For instance, because I have not worked with threads, I do not know the difference between a Mutex and a Semaphore. We all know what Create means, but a short description would go a long way towards helping us know which we need to learn more about.
Command Index

CreateMutex
CreateSemaphore
CreateThread
FreeMutex
FreeSemaphore
IsThread
...etc
Showing a description in that list, much like you have it with the constants would be very helpful:

Code: Select all

  #PB_Compiler_Date     : Current date, at the compile time, in the PureBasic  date format.
  #PB_Compiler_File     : Full path and name of the file being compiled, useful for debug purpose.
  #PB_Compiler_FilePath : Full path of the file being compiled, useful for debug purpose.
  #PB_Compiler_Filename : Filename (without path) of the file being compiled, useful for debug purpose.
  #PB_Compiler_Line     : Line number of the file being compiled, useful for debug purpose.
 
Thanks.
User avatar
langinagel
Enthusiast
Enthusiast
Posts: 131
Joined: Fri Jan 28, 2005 11:53 pm
Location: Germany
Contact:

Re: Command summaries in the Indeces

Post by langinagel »

Finally I think I understood your request.

I disagree.
The list is good enough, though the names of the functions are descriptive enough. For more information click on the link for the explanation of the function.
Changing the help-files in such a way would cause a big effort. What for?

And...if semaphore and mutex or something else is not clear enough, try wikipedia.
Or this forum.

-1
https://www.doerpsoft.org

Boost. Work. Efficiency.
Post Reply