Skip to content

Commit

Permalink
[DOC-REVIEW] Frames README: Add client constructor Return Value (v3io#3
Browse files Browse the repository at this point in the history
…) (PR 292 #2c)
  • Loading branch information
Sharon-iguazio committed Sep 26, 2019
1 parent bc1345c commit 5c7cbd3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ All Frames operations are executed via an object of the `Client` class.

- [Syntax](#client-constructor-syntax)
- [Parameters and Data Members](#client-constructor-parameters)
- [Return Value](#client-constructor-return-value)
- [Example](#client-constructor-example)

<a id="client-constructor-syntax"></a>
Expand Down Expand Up @@ -143,6 +144,11 @@ Client(address='', container='', user='', password='', token='')
- **Requirement:** Required when neither the [`user`](#client-param-user) or [`password`](#client-param-password) parameters or the authentication environment variables are set.
See [User Authentication](#user-authentication).

<a id="client-constructor-return-value"></a>
#### Return Value

Returns a new Frames `Client` data object.

<a id="client-constructor-example"></a>
#### Example

Expand Down

0 comments on commit 5c7cbd3

Please sign in to comment.