summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWouter Bolsterlee <uws@xs4all.nl>2013-11-03 17:26:50 +0100
committerWouter Bolsterlee <uws@xs4all.nl>2013-11-03 17:26:50 +0100
commit4d5390e0b96fbb9d297ef5e7584baa69b32fb136 (patch)
tree810f86fc49190305d41cd2727543df7b51ad4751
parent00759c4b9de10d0fb918e22247017673e62415bc (diff)
downloadhappybase-4d5390e0b96fbb9d297ef5e7584baa69b32fb136.tar.gz
Expand docs for the 'wal' arg for Batch.put() and .delete()
-rw-r--r--happybase/batch.py10
1 files changed, 7 insertions, 3 deletions
diff --git a/happybase/batch.py b/happybase/batch.py
index 695da50..5e51410 100644
--- a/happybase/batch.py
+++ b/happybase/batch.py
@@ -67,7 +67,9 @@ class Batch(object):
"""Store data in the table.
See :py:meth:`Table.put` for a description of the `row`, `data`,
- and `wal` arguments.
+ and `wal` arguments. The `wal` argument should normally not be
+ used; its only use is to override the batch-wide value passed to
+ :py:meth:`Table.batch`.
"""
if wal is None:
wal = self._wal
@@ -87,8 +89,10 @@ class Batch(object):
def delete(self, row, columns=None, wal=None):
"""Delete data from the table.
- See :py:meth:`Table.delete` for a description of the `row`,
- `columns`, and `wal` arguments.
+ See :py:meth:`Table.put` for a description of the `row`, `data`,
+ and `wal` arguments. The `wal` argument should normally not be
+ used; its only use is to override the batch-wide value passed to
+ :py:meth:`Table.batch`.
"""
# Work-around Thrift API limitation: the mutation API can only
# delete specified columns, not complete rows, so just list the