Added docstring to wikipedia plugin

2016-03-16 01:03:00 +00:00
parent d9385942c0
commit 1d51ebf923
1 changed files with 30 additions and 0 deletions
--- a/wikipedia-prof.py
+++ b/wikipedia-prof.py
@@ -1,3 +1,33 @@
+"""
+Requires wikipedia API
+    pip install wikipedia
+
+Example theme options:
+
+[wikipedia]
+error=red
+search=bold_green
+search.noresult=red
+search.results=green
+summary.nopage=red
+summary.title=bold_green
+summary.url=magenta
+summary.text=cyan
+page.nopage=red
+page.title=bold_green
+page.text=cyan
+images.nopage=red
+images=bold_green
+images.url=magenta
+links.nopage=red
+links=bold_green
+links.link=green
+refs.nopage=red
+refs=bold_green
+refs.url=magenta
+
+"""
+
 import prof

 import wikipedia