Added docstrings to plugins

This commit is contained in:
James Booth
2016-03-26 02:38:18 +00:00
parent 0446048b57
commit 609f0cb7fc
5 changed files with 30 additions and 0 deletions

View File

@@ -1,3 +1,12 @@
"""
Print something in ASCII text.
Running from the console will print the text to the console.
Running in a chat or room window will send the ASCII text
Requires 'figlet' which is available on most linux distros e.g.:
sudo apt-get install figlet
"""
import prof
import subprocess

View File

@@ -1,3 +1,7 @@
"""
Open the last link received in a chat or room window using the systems default browser
"""
import prof
import os
import webbrowser

View File

@@ -1,3 +1,7 @@
"""
Convert smileys ( :) :( etc) to the Unicode character representation
"""
import prof
def _emote(input_str):

View File

@@ -1,3 +1,7 @@
"""
Paste the contents of the clipboard when in a chat or room window.
"""
import prof
import sys
import Tkinter as tk

9
say.py
View File

@@ -1,3 +1,12 @@
"""
Read message out loud.
On linux requires 'espeak' which is available on most distributions e.g.:
sudo apt-get install espeak
On OSX will use the built in 'say' command.
"""
import prof
import os
from sys import platform