Permalink
Browse files

documentation updates

  • Loading branch information...
1 parent 663c3ef commit 82dfbc07a56dc7165db0c416ac42530e2f5d5cff dcurtis committed Aug 23, 2009
Showing with 30 additions and 17 deletions.
  1. +26 −14 caw/widgets/mpdc.py
  2. +1 −1 caw/widgets/volume.py
  3. +2 −2 caw/widgets/weather.py
  4. +1 −0 doc/source/reference/widgets.rst
View
@@ -13,20 +13,30 @@ class MPDC(caw.widget.Widget):
fg : text color of this widget
play_format : format of the text to display when a song is playing. \
- (default "%(artist)s - %(title)s") \
- \
-
- Possible replacement strings: \
- artist : artist name \
- title : song title \
- album : album name \
- file : filename of the song \
- track : current track / total tracks \
- date : date of the song \
- elapsed_min : minutes elapsed thus far \
- elapsed_sec : seconds into the minute elapsed \
- total_min : minutes of length \
- total_sec : seconds into the minute for total length
+ See the list of possible replacement strings below. \
+ (default "%(artist)s - %(title)s")
+
+ valid substitution labels: \
+
+ artist : artist name
+
+ title : song title
+
+ album : album name
+
+ file : filename of the song
+
+ track : current track / total tracks
+
+ date : date of the song
+
+ elapsed_min : minutes elapsed thus far
+
+ elapsed_sec : seconds into the minute elapsed
+
+ total_min : minutes of length
+
+ total_sec : seconds into the minute for total length
pause_format : format of the text to display when paused. \
The same formatting strings as 'play_format' are allowed. \
@@ -37,6 +47,8 @@ class MPDC(caw.widget.Widget):
hostname : hostname to connect to
port : port to connect to
+
+ There are stuff
"""
_initialized = False
View
@@ -11,7 +11,7 @@
class Volume(caw.widget.Widget):
"""Volume Widgets
- Parameter
+ Parameters
----------
device : audio device
View
@@ -16,8 +16,8 @@
class Weather(caw.widget.Widget):
"""Weather Widget
- Arguments
- ---------
+ Parameters
+ ------------
zipcode : location zipcode
@@ -13,6 +13,7 @@ caw.widgets
fifo
text
cpu
+ mpdc
systray
net
allornothing

0 comments on commit 82dfbc0

Please sign in to comment.