Skip to content

Commit fd3ed55

Browse files
committed
Updated docstring in connection and encodedsession
1 parent 7c655a0 commit fd3ed55

2 files changed

Lines changed: 229 additions & 86 deletions

File tree

pynuodb/connection.py

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ def connect(database, host, user, password, options=None):
3131
Some common options include:
3232
"schema"
3333
34-
@type database str
35-
@type host str
36-
@type user str
37-
@type password str
38-
@type options dict[str,str]
34+
:type database: str
35+
:type host: str
36+
:type user: str
37+
:type password: str
38+
:type options: dict[str,str]
3939
"""
4040
return Connection(database, host, user, password, options)
4141

@@ -78,11 +78,11 @@ def __init__(self, dbName, broker, username, password, options):
7878
Returns:
7979
a Connection instance
8080
81-
@type dbName str
82-
@type broker str
83-
@type username str
84-
@type password str
85-
@type options dict[str,str]
81+
:type dbName: str
82+
:type broker: str
83+
:type username: str
84+
:type password: str
85+
:type options: dict[str,str]
8686
"""
8787
(host, port) = getCloudEntry(broker, dbName)
8888
self.__session = EncodedSession(host, port)
@@ -114,11 +114,7 @@ def testConnection(self):
114114
name: ONE
115115
value: 1
116116
117-
Arguments:
118-
None
119-
120-
Returns:
121-
None
117+
:rtype: None
122118
"""
123119
self.__session.test_connection()
124120

0 commit comments

Comments
 (0)