Skip to content

Commit 872e9ac

Browse files
author
Cameron Waterman
authored
fix: Fix various documentation issues (#42)
1 parent 1e372ce commit 872e9ac

File tree

1 file changed

+67
-8
lines changed

1 file changed

+67
-8
lines changed

‎nisystemlink/clients/dataframe/_data_frame_client.py

+67-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
1717
Args:
1818
configuration: Defines the web server to connect to and information about
1919
how to connect. If not provided, an instance of
20-
:class:`core.JupyterHttpConfiguration` is used.
20+
:class:`JupyterHttpConfiguration <nisystemlink.clients.core.JupyterHttpConfiguration>`
21+
is used.
22+
23+
Raises:
24+
ApiException: if unable to communicate with the Data Frame service.
2125
"""
2226
if configuration is None:
2327
configuration = core.JupyterHttpConfiguration()
@@ -26,7 +30,14 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
2630

2731
@get("")
2832
def api_info(self) -> models.ApiInfo:
29-
"""Returns information about available API operations."""
33+
"""Get information about available API operations.
34+
35+
Returns:
36+
Information about available API operations.
37+
38+
Raises:
39+
ApiException: if unable to communicate with the Data Frame service.
40+
"""
3041
...
3142

3243
@get(
@@ -60,7 +71,11 @@ def list_tables(
6071
workspace: List of workspace IDs to filter by.
6172
6273
Returns:
63-
models.PagedTables: The list of tables with a continuation token.
74+
The list of tables with a continuation token.
75+
76+
Raises:
77+
ApiException: if unable to communicate with the Data Frame service
78+
or provided an invalid argument.
6479
"""
6580
...
6681

@@ -73,6 +88,10 @@ def create_table(self, table: models.CreateTableRequest) -> str:
7388
7489
Returns:
7590
The ID of the newly created table.
91+
92+
Raises:
93+
ApiException: if unable to communicate with the Data Frame service
94+
or provided an invalid argument.
7695
"""
7796
...
7897

@@ -84,7 +103,11 @@ def query_tables(self, query: models.QueryTablesRequest) -> models.PagedTables:
84103
query: The request to query tables.
85104
86105
Returns:
87-
models.PagedTables: The list of tables with a continuation token.
106+
The list of tables with a continuation token.
107+
108+
Raises:
109+
ApiException: if unable to communicate with the Data Frame service
110+
or provided an invalid argument.
88111
"""
89112
...
90113

@@ -96,7 +119,11 @@ def get_table_metadata(self, id: str) -> models.TableMetadata:
96119
id (str): Unique ID of a DataFrame table.
97120
98121
Returns:
99-
models.TableMetadata: The metadata for the table.
122+
The metadata for the table.
123+
124+
Raises:
125+
ApiException: if unable to communicate with the Data Frame service
126+
or provided an invalid argument.
100127
"""
101128
...
102129

@@ -107,6 +134,10 @@ def modify_table(self, id: str, update: models.ModifyTableRequest) -> None:
107134
Args:
108135
id: Unique ID of a DataFrame table.
109136
update: The metadata to update.
137+
138+
Raises:
139+
ApiException: if unable to communicate with the Data Frame service
140+
or provided an invalid argument.
110141
"""
111142
...
112143

@@ -116,6 +147,10 @@ def delete_table(self, id: str) -> None:
116147
117148
Args:
118149
id (str): Unique ID of a DataFrame table.
150+
151+
Raises:
152+
ApiException: if unable to communicate with the Data Frame service
153+
or provided an invalid argument.
119154
"""
120155
...
121156

@@ -131,6 +166,10 @@ def delete_tables(
131166
Returns:
132167
A partial success if any tables failed to delete, or None if all
133168
tables were deleted successfully.
169+
170+
Raises:
171+
ApiException: if unable to communicate with the Data Frame service
172+
or provided an invalid argument.
134173
"""
135174
...
136175

@@ -146,6 +185,10 @@ def modify_tables(
146185
Returns:
147186
A partial success if any tables failed to be modified, or None if all
148187
tables were modified successfully.
188+
189+
Raises:
190+
ApiException: if unable to communicate with the Data Frame service
191+
or provided an invalid argument.
149192
"""
150193
...
151194

@@ -184,7 +227,11 @@ def get_table_data(
184227
continuation_token: The token used to paginate results.
185228
186229
Returns:
187-
models.PagedTableRows: The table data and total number of rows with a continuation token.
230+
The table data and total number of rows with a continuation token.
231+
232+
Raises:
233+
ApiException: if unable to communicate with the Data Frame service
234+
or provided an invalid argument.
188235
"""
189236
...
190237

@@ -195,6 +242,10 @@ def append_table_data(self, id: str, data: models.AppendTableDataRequest) -> Non
195242
Args:
196243
id: Unique ID of a DataFrame table.
197244
data: The rows of data to append and any additional options.
245+
246+
Raises:
247+
ApiException: if unable to communicate with the Data Frame service
248+
or provided an invalid argument.
198249
"""
199250
...
200251

@@ -209,7 +260,11 @@ def query_table_data(
209260
query: The filtering and sorting to apply when reading data.
210261
211262
Returns:
212-
models.PagedTableRows: The table data and total number of rows with a continuation token.
263+
The table data and total number of rows with a continuation token.
264+
265+
Raises:
266+
ApiException: if unable to communicate with the Data Frame service
267+
or provided an invalid argument.
213268
"""
214269
...
215270

@@ -224,6 +279,10 @@ def query_decimated_data(
224279
query: The filtering and decimation options to apply when reading data.
225280
226281
Returns:
227-
models.TableRows: The decimated table data.
282+
The decimated table data.
283+
284+
Raises:
285+
ApiException: if unable to communicate with the Data Frame service
286+
or provided an invalid argument.
228287
"""
229288
...

0 commit comments

Comments
 (0)