[doc] add note about module RST documentation
This commit is contained in:
parent
f49300e568
commit
b3e4c7503b
1 changed files with 5 additions and 1 deletions
|
@ -40,7 +40,11 @@ This example will show “hello world” in the status bar:
|
||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
"""Short description"""
|
"""Short description in RST format
|
||||||
|
|
||||||
|
please have a look at other modules, this will go into the
|
||||||
|
documentation verbatim (list of modules)
|
||||||
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
import core.widget
|
import core.widget
|
||||||
|
|
Loading…
Reference in a new issue