diff options
| author | James Booth <boothj5@gmail.com> | 2016-07-30 19:06:21 +0100 |
|---|---|---|
| committer | James Booth <boothj5@gmail.com> | 2016-07-30 19:06:21 +0100 |
| commit | c8d231fc75b1e700630b92c5073233ebefa4edda (patch) | |
| tree | 2781c408be9f6e56fec8c0285c47d3dcdbe83523 /apidocs/python/src/prof.py | |
| parent | 56afe214d40983f3c7e44fd262fc6545c4858773 (diff) | |
| download | profani-tty-c8d231fc75b1e700630b92c5073233ebefa4edda.tar.gz | |
Update python API docs
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. """ |