Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Fix various documentation issues #42

Merged
merged 10 commits into from
Jan 26, 2023
Merged

fix: Fix various documentation issues #42

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f0e8b38
First pass
cameronwaterman Jan 23, 2023
486145a
Fix return type
cameronwaterman Jan 23, 2023
6ec730e
Fix return types
cameronwaterman Jan 23, 2023
62f06b7
Format
cameronwaterman Jan 23, 2023
75e3161
Fix JupyterHttpConfiguration link
cameronwaterman Jan 23, 2023
fd9ae07
Attempt to fix link
cameronwaterman Jan 23, 2023
42481f3
Use fully qualified path
cameronwaterman Jan 23, 2023
27ceee0
Shorten link
cameronwaterman Jan 23, 2023
888863c
Use explicit title for link
cameronwaterman Jan 23, 2023
1027f4f
If -> if
cameronwaterman Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 67 additions & 8 deletions nisystemlink/clients/dataframe/_data_frame_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
Args:
configuration: Defines the web server to connect to and information about
how to connect. If not provided, an instance of
:class:`core.JupyterHttpConfiguration` is used.
:class:`JupyterHttpConfiguration <nisystemlink.clients.core.JupyterHttpConfiguration>`
is used.

Raises:
ApiException: if unable to communicate with the Data Frame service.
"""
if configuration is None:
configuration = core.JupyterHttpConfiguration()
Expand All @@ -26,7 +30,14 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):

@get("")
def api_info(self) -> models.ApiInfo:
"""Returns information about available API operations."""
"""Get information about available API operations.

Returns:
Information about available API operations.

Raises:
ApiException: if unable to communicate with the Data Frame service.
"""
...

@get(
Expand Down Expand Up @@ -60,7 +71,11 @@ def list_tables(
workspace: List of workspace IDs to filter by.

Returns:
models.PagedTables: The list of tables with a continuation token.
The list of tables with a continuation token.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -73,6 +88,10 @@ def create_table(self, table: models.CreateTableRequest) -> str:

Returns:
The ID of the newly created table.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -84,7 +103,11 @@ def query_tables(self, query: models.QueryTablesRequest) -> models.PagedTables:
query: The request to query tables.

Returns:
models.PagedTables: The list of tables with a continuation token.
The list of tables with a continuation token.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -96,7 +119,11 @@ def get_table_metadata(self, id: str) -> models.TableMetadata:
id (str): Unique ID of a DataFrame table.

Returns:
models.TableMetadata: The metadata for the table.
The metadata for the table.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -107,6 +134,10 @@ def modify_table(self, id: str, update: models.ModifyTableRequest) -> None:
Args:
id: Unique ID of a DataFrame table.
update: The metadata to update.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -116,6 +147,10 @@ def delete_table(self, id: str) -> None:

Args:
id (str): Unique ID of a DataFrame table.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -131,6 +166,10 @@ def delete_tables(
Returns:
A partial success if any tables failed to delete, or None if all
tables were deleted successfully.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -146,6 +185,10 @@ def modify_tables(
Returns:
A partial success if any tables failed to be modified, or None if all
tables were modified successfully.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand Down Expand Up @@ -184,7 +227,11 @@ def get_table_data(
continuation_token: The token used to paginate results.

Returns:
models.PagedTableRows: The table data and total number of rows with a continuation token.
The table data and total number of rows with a continuation token.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -195,6 +242,10 @@ def append_table_data(self, id: str, data: models.AppendTableDataRequest) -> Non
Args:
id: Unique ID of a DataFrame table.
data: The rows of data to append and any additional options.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -209,7 +260,11 @@ def query_table_data(
query: The filtering and sorting to apply when reading data.

Returns:
models.PagedTableRows: The table data and total number of rows with a continuation token.
The table data and total number of rows with a continuation token.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...

Expand All @@ -224,6 +279,10 @@ def query_decimated_data(
query: The filtering and decimation options to apply when reading data.

Returns:
models.TableRows: The decimated table data.
The decimated table data.

Raises:
ApiException: if unable to communicate with the Data Frame service
or provided an invalid argument.
"""
...