PDA

View Full Version : Documentating function names


aaThomas
05-08-2007, 02:47 AM
Hi there!

I have a hard time finding documentation of a function when searching the docs on the name of the function. I recommend to add the function names to the index.

Cheers, Thomas

farshizzo
05-08-2007, 09:31 AM
Hi,

Can you be more specific about which functions are not being indexed? The entire command reference should be included in searches. Maybe the command is not documented.

aaThomas
05-11-2007, 11:42 AM
Ow, my mistake! It concerned the random module, but documentation about module is covered in Basic Concepts -> The Python Language -> Learning Python

farshizzo
05-11-2007, 11:53 AM
Hi,

Don't forget that Vizard includes the entire Python manual. You can access it under "Help -> Python Help" menu. You can search all the python commands from this help file.

aaThomas
05-15-2007, 09:46 AM
Thanks for the tip; a lovely list with all the possible random functions was quickly obtained :-).

One idea; maybe it would be handy to integrate this help file with the standard vizard help. Then you could search for any Vizard supported function (or method, whatever) with one search.

farshizzo
05-15-2007, 09:50 AM
I believe it is possible to create a help file that references two external help files, so that might actually work. We'll give it a try, thanks for the idea!