X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fpython_doc_compl.dox;h=fa29dcab3e8c8eda06a05059001002fb2bdaa383;hb=cca842065fd2bb93bae7ed6c32a7de16b06f94d9;hp=aee8594cde650d57cb6aebff757d61652b813987;hpb=1d633fa1c13b169da8b4f8a5cfad4587bf586b0b;p=modules%2Fkernel.git diff --git a/doc/salome/python_doc_compl.dox b/doc/salome/python_doc_compl.dox index aee8594cd..fa29dcab3 100644 --- a/doc/salome/python_doc_compl.dox +++ b/doc/salome/python_doc_compl.dox @@ -40,10 +40,10 @@ named salome, and then sub-packages could be created for each The motivations of this objective are twice: - Definitively prevent the risk of naming conflict between python - modules coming from different %SALOME modules. Today, the developper + modules coming from different %SALOME modules. Today, the developer of a module has to take care of the names used in other modules to choose a name. -- Integrate in %SALOME some python modules initialy developed in the +- Integrate in %SALOME some python modules initially developed in the context of domain specific %SALOME applications (%SALOME-MECA, %SALOME-CFD, OPENTURN, PANTHERE) and whose source files are organized in a packaged python structure. @@ -76,7 +76,7 @@ and all other stuff should be imported and work as before). To reach this target, we have to face two problems: - %A naming conflict with the instruction import salome. The result - is unpredictible because of the existance in the sys.path of + is unpredictable because of the existence in the sys.path of both a file salome.py and a package \b salome. - The dispatching of salome.* sub-packages in the different %SALOME modules. @@ -184,7 +184,7 @@ module are leaft untouched but the file salome.py. One special point for the documentation: -- The documentation of the python package API is writen in HTML +- The documentation of the python package API is written in HTML and generated form the source code with doxygen. - The *.dox (doxygen file) source files are located in the directory /doc/salome.