Merge pull request #68 from opengisch/fix_examples

Example docs adjustments and fixes
opengisch · Oct 4, 2024 · 9ea0096 · 9ea0096
2 parents 6c5f53c + 7d5f64a
commit 9ea0096
Showing 1 changed file with 12 additions and 6 deletions.
diff --git 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():