Skip to content

Commit a81a4a9

Browse files
committed
Improve docs compliance with project
1 parent 68fdb97 commit a81a4a9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

happybase/connection.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,13 @@ class Connection(object):
8787
The optional `use_kerberos` argument allows you to establish a
8888
secure connection to HBase. This argument requires a buffered
8989
`transport` protocol. You must first authorize yourself with
90-
your KDC by using kinit (e.g. kinit -kt my.keytab user@REALM)
90+
your KDC by using `kinit` (e.g. `kinit -kt my.keytab user@REALM`)
91+
92+
The optional `sasl_service` argument allows to specify the name of
93+
the sasl service.
94+
95+
.. versionadded:: 0.9.1
96+
`use_kerberos` and `sasl_service` arguments
9197
9298
.. versionadded:: 0.9
9399
`protocol` argument
@@ -109,8 +115,8 @@ class Connection(object):
109115
:param str table_prefix_separator: Separator used for `table_prefix`
110116
:param str compat: Compatibility mode (optional)
111117
:param str transport: Thrift transport mode (optional)
112-
:param bool use_kerberos: Connect to HBase via a secure connection (default: False)
113-
:param str sasl_service: The name of the SASL service (default: hbase)
118+
:param bool use_kerberos: Connect to HBase via a secure connection (optional)
119+
:param str sasl_service: The name of the SASL service (optional)
114120
"""
115121
def __init__(self, host=DEFAULT_HOST, port=DEFAULT_PORT, timeout=None,
116122
autoconnect=True, table_prefix=None,

0 commit comments

Comments
 (0)