Skip to content

Commit

Permalink
[DOC-REVIEW] Frames README & help text: Edit the execute method descr…
Browse files Browse the repository at this point in the history
…iption (PR 292 v3io#4)
  • Loading branch information
Sharon-iguazio committed Sep 26, 2019
1 parent 58d713b commit fb03aca
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The `Client` class features the following methods for supporting basic data oper
- [`delete`](#method-delete) — deletes a table or stream or specific table items
- [`read`](#method-read) — reads data from a table or stream into pandas DataFrames.
- [`write`](#method-write) — writes data from pandas DataFrames to a table or stream.
- [`execute`](#method-execute) — executes a custom command on a table or stream.
- [`execute`](#method-execute) — executes a backend-specific command on a table or stream.
Each backend may support multiple commands.

<a id="backend-types"></a>
Expand Down Expand Up @@ -522,7 +522,7 @@ df = client.delete(backend="kv", table="mytable", filter="age > 40")
<a id="method-execute"></a>
### execute Method

Extends the basic CRUD functionality of the other client methods via custom commands.
Extends the basic CRUD functionality of the other client methods via backend-specific commands.

- [Syntax](#method-execute-syntax)
- [Common parameters](#method-execute-common-params)
Expand Down
2 changes: 1 addition & 1 deletion clients/py/v3io_frames/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ def delete(self, backend, table, filter='', start='', end='',
return self._delete(backend, table, filter, start, end, if_missing)

def execute(self, backend, table, command='', args=None, expression=''):
"""Executes a custom command on a table or stream
"""Executes a backend-specific command on a table or stream
Parameters
----------
Expand Down

0 comments on commit fb03aca

Please sign in to comment.