summaryrefslogtreecommitdiff
path: root/ttystatus/status.py
diff options
context:
space:
mode:
Diffstat (limited to 'ttystatus/status.py')
-rw-r--r--ttystatus/status.py3
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):