From 7d5f64ab93abf637f7b7594bcd1c8f0a8016a7eb Mon Sep 17 00:00:00 2001 From: Ivan Ivanov Date: Fri, 4 Oct 2024 22:04:24 +0300 Subject: [PATCH] Example docs adjustments and fixes --- qfieldcloud_sdk/sdk.py | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/qfieldcloud_sdk/sdk.py b/qfieldcloud_sdk/sdk.py index f25370b..5cc7aa8 100644 --- a/qfieldcloud_sdk/sdk.py +++ b/qfieldcloud_sdk/sdk.py @@ -435,6 +435,11 @@ def patch_project( Returns: Dict[str, Any]: the updated project + + Example: + ```python + client.patch_project(description="New Description") + ``` """ project_data: dict[str, Any] = {} @@ -691,12 +696,12 @@ def list_jobs( A list of dictionaries representing the jobs. Example: - ```python - client.list_jobs( - project_id="123e4567-e89b-12d3-a456-426614174000", - job_type=JobTypes.PACKAGE - ) - ``` + ```python + client.list_jobs( + project_id="123e4567-e89b-12d3-a456-426614174000", + job_type=JobTypes.PACKAGE + ) + ``` """ payload = self._request_json( "GET", @@ -1074,6 +1079,7 @@ def download_file( remote_filename="trees.gpkg", show_progress=True ) + ``` """ if remote_etag and local_filename.exists():