Skip to content

Commit 4e99271

Browse files
committed
docs(export): fix get_raw_export_bytes docstring to be format-agnostic
1 parent eb6a32e commit 4e99271

File tree

1 file changed

+6
-4
lines changed
  • packages/gooddata-sdk/src/gooddata_sdk/catalog/export

1 file changed

+6
-4
lines changed

packages/gooddata-sdk/src/gooddata_sdk/catalog/export/service.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -338,10 +338,12 @@ def get_raw_export_bytes(
338338
max_retry: float = 5.0,
339339
) -> bytes:
340340
"""
341-
Poll the raw export endpoint for an already-submitted export and return the Arrow IPC bytes.
341+
Poll the raw export endpoint for an already-submitted export and return its bytes.
342342
343-
The caller is responsible for submitting the AFM execution and the export request
344-
(via ``actions_api.create_raw_export``), then passing the resulting ``export_id`` here.
343+
Low-level building block: the caller is responsible for submitting the export request
344+
(via ``actions_api.create_raw_export``) and passing the resulting ``export_id`` here.
345+
The returned bytes reflect whatever format was requested at creation time
346+
(``ARROW_FILE``, ``ARROW_STREAM``, or ``CSV``).
345347
346348
Args:
347349
workspace_id (str): The ID of the target workspace.
@@ -351,7 +353,7 @@ def get_raw_export_bytes(
351353
max_retry (float): Maximum wait between retries in seconds. Defaults to 5.0.
352354
353355
Returns:
354-
bytes: Arrow IPC bytes that can be read with ``pyarrow.ipc.open_file``.
356+
bytes: Raw export bytes in the format requested at submission time.
355357
"""
356358
return self._get_exported_content(
357359
workspace_id=workspace_id,

0 commit comments

Comments
 (0)