diff options
author | Lars Wirzenius <liw@liw.fi> | 2011-08-31 16:17:56 +0100 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2011-08-31 16:17:56 +0100 |
commit | 8420760a2b335732c9f5bc63623fa0ed08e1319a (patch) | |
tree | 6a181c7b82868fac7febfe3f5a22724ae30dbbaa | |
parent | 54c0b2df27006e3705a5213ad0a75e71fafa0709 (diff) | |
download | python-ttystatus-8420760a2b335732c9f5bc63623fa0ed08e1319a.tar.gz |
Add an example to docstring.
-rw-r--r-- | ttystatus/status.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/ttystatus/status.py b/ttystatus/status.py index e8192e3..24f369b 100644 --- a/ttystatus/status.py +++ b/ttystatus/status.py @@ -50,7 +50,8 @@ class TerminalStatus(object): The format string is taken literally, except that ``%%`` is a literal percent character, and ``%Foo(a,b,c)`` is a widget - of type ``Foo`` with parameters a, b, and c. + of type ``Foo`` with parameters a, b, and c. For example: + ``format("hello, %String(name)")``. ''' for widget in ttystatus.fmt.parse(format_string): |