Vague description of required class/function naming convention

[AlexExle]

Good day,

I've tried to play with NVDA addons using this guide and have foundone annoying issue with this guide.
There is no clear and comprehensive requirements about naming for class/funcion.
Only thru painfull process of trials and errors I have found that class name of AppModule should be exactly "AppModule" with the same capital letters and names of functions which are assigned for gestures always should be starting from "script_".

Furthermore, I've spotted one place where there is the error in naming :

For instance, if you wish to add support for a program, after importing appModuleHandler and other needed modules, you would write:
class appModule(appModuleHandler.AppModule):

So I assume as far as first char of the class name is in lowercase it shouldn't work.

I assume there are another naming convention rules, like "event_" for even handler functions.

So I think it would be really helpfull to have section with such cleary described naming rules somewhere in the beginning of the guide.

If this description already exists somewhere in other document, could you please provide it?

Because it really annoying to understand it just base on examples, especially for people with limited accessibility (blind people).

Another minor question is: do you have comprehensive documentation of functionality for modules noticed in List of useful NVDA core modules and methods ? Or the only way to understand their capabilities is to dig in the source code?

Thanks,
Alex

[josephsl]

Hi, ah, these are good questions. A full list of conventions used to name classes and functions can be found in NVDA developer guide published by NV Access, although I think it won’t hurt to publish a brief description in the add-on guide in the future. Thanks.