summaryrefslogtreecommitdiff
path: root/blessings/__init__.py
diff options
context:
space:
mode:
authorErik Rose <erik@mozilla.com>2012-02-01 14:03:20 -0800
committerErik Rose <erik@mozilla.com>2012-02-01 14:03:20 -0800
commit103f089a2081a83a1d0fc471c2aa484ce30da407 (patch)
treeb5f1d8443cf8fec85095acf4d65c75bec2838953 /blessings/__init__.py
parent4ab628f086ad697243159d4700a5e661297d748d (diff)
downloadblessings-103f089a2081a83a1d0fc471c2aa484ce30da407.tar.gz
Document an idiom for restoring the cursor location after a series of manual moves. Closes #17.
Diffstat (limited to 'blessings/__init__.py')
-rw-r--r--blessings/__init__.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/blessings/__init__.py b/blessings/__init__.py
index 080fe26..dbd4b69 100644
--- a/blessings/__init__.py
+++ b/blessings/__init__.py
@@ -213,7 +213,10 @@ class Terminal(object):
print 'I can do it %i times!' % x
Specify ``x`` to move to a certain column, ``y`` to move to a certain
- row, or both.
+ row, both, or neither. If you specify neither, only the saving and
+ restoration of cursor position will happen. This can be useful if you
+ simply want to restore your place after doing some manual cursor
+ movement.
"""
return Location(self, x, y)