Update python API docs

2016-07-30 19:06:21 +01:00
parent 56afe214d4
commit c8d231fc75
2 changed files with 250 additions and 8 deletions
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -1,5 +1,11 @@
 """
-Profanity plugin API
+This module contains the functions available to plugins to interact with Profanity.
+
+The ``prof`` module must be imported
+::
+    import prof
+
+Profanity accepts both ``str`` and ``unicode`` objects as string arguments, to allow plugins to work with both Python 2 and 3.
 """