moparisthebest
/
Simba
mirror of https://github.com/moparisthebest/Simba
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge branch 'master' of ssh://villavu.com:54367/simba

This commit is contained in:
Merlijn Wajer 2010-06-13 22:50:59 +02:00
parent 2ae094477b ece7268a51
commit 5904dec440
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/sphinx/docdoc.rst
View File

@ -61,9 +61,9 @@ Any other files can be put directly in the root of the sphinx folder.
Capitalisation
~~~~~~~~~~~~~~
The titles of all major sections have all worlds capitalized. (The ones with
The titles of all major sections have all words capitalized. (The ones with
===)
The minor sections and subsections (---) and (~~~) have only the first word
The minor sections and subsections (---) and (~~~) have only the first word and
Simba specific words (like Simba itself) capitalized.
Try to stick to the Python documentation standards.

10
Doc/sphinx/simbaref/extensions.rst
View File

@ -189,6 +189,8 @@ onOpenFile
onColourPick
~~~~~~~~~~~~
This function breaks naming procedure. Bug Wizzup to use "Color".
onScriptStart
~~~~~~~~~~~~~
@ -196,11 +198,11 @@ onScriptStart
Special Cases
-------------
.. his is supposed to document the special cases, and multiple extensions
.. This is supposed to document the special cases, and multiple extensions
hooking onto the same event is a special case.
Multiple extensions hooking onto the same event
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Multiple extensions hooking the same event
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
So what happens when multiple extensions hook onto the same event/hook?
@ -216,7 +218,7 @@ Pitfalls
--------
Extensions can be very dangerous in the sense that they run on the main thread
of Simba, it is very easy to crash Simba or make it hang. There is
of Simba; it is very easy to crash Simba or cause it to hang. There is
no way to prevent this, so make sure to check what you're doing before you try
your own (or someone else's) extension.