diff options
Diffstat (limited to 'apidocs/python/src/prof.py')
| -rw-r--r-- | apidocs/python/src/prof.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index 99d00a94..297960e6 100644 --- 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. """ |