Added docstrings to plugins
This commit is contained in:
9
ascii.py
9
ascii.py
@@ -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 prof
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
|
"""
|
||||||
|
Open the last link received in a chat or room window using the systems default browser
|
||||||
|
"""
|
||||||
|
|
||||||
import prof
|
import prof
|
||||||
import os
|
import os
|
||||||
import webbrowser
|
import webbrowser
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
|
"""
|
||||||
|
Convert smileys ( :) :( etc) to the Unicode character representation
|
||||||
|
"""
|
||||||
|
|
||||||
import prof
|
import prof
|
||||||
|
|
||||||
def _emote(input_str):
|
def _emote(input_str):
|
||||||
|
|||||||
4
paste.py
4
paste.py
@@ -1,3 +1,7 @@
|
|||||||
|
"""
|
||||||
|
Paste the contents of the clipboard when in a chat or room window.
|
||||||
|
"""
|
||||||
|
|
||||||
import prof
|
import prof
|
||||||
import sys
|
import sys
|
||||||
import Tkinter as tk
|
import Tkinter as tk
|
||||||
|
|||||||
9
say.py
9
say.py
@@ -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 prof
|
||||||
import os
|
import os
|
||||||
from sys import platform
|
from sys import platform
|
||||||
|
|||||||
Reference in New Issue
Block a user