Skip to content

Commit 7d5f64a

Browse files
committed
Example docs adjustments and fixes
1 parent 6c5f53c commit 7d5f64a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

qfieldcloud_sdk/sdk.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,11 @@ def patch_project(
435435
436436
Returns:
437437
Dict[str, Any]: the updated project
438+
439+
Example:
440+
```python
441+
client.patch_project(description="New Description")
442+
```
438443
"""
439444
project_data: dict[str, Any] = {}
440445

@@ -691,12 +696,12 @@ def list_jobs(
691696
A list of dictionaries representing the jobs.
692697
693698
Example:
694-
```python
695-
client.list_jobs(
696-
project_id="123e4567-e89b-12d3-a456-426614174000",
697-
job_type=JobTypes.PACKAGE
698-
)
699-
```
699+
```python
700+
client.list_jobs(
701+
project_id="123e4567-e89b-12d3-a456-426614174000",
702+
job_type=JobTypes.PACKAGE
703+
)
704+
```
700705
"""
701706
payload = self._request_json(
702707
"GET",
@@ -1074,6 +1079,7 @@ def download_file(
10741079
remote_filename="trees.gpkg",
10751080
show_progress=True
10761081
)
1082+
```
10771083
"""
10781084

10791085
if remote_etag and local_filename.exists():

0 commit comments

Comments
 (0)