Skip to content

Commit c1eff09

Browse files
author
Mike
committed
Add resource method mark_data_updated and parameter data_updated to create_in_hdx and update_in_hdx of resource
1 parent f51065d commit c1eff09

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

documentation/main.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -896,30 +896,31 @@ You can download a resource using the **download** function eg.
896896

897897
If you do not supply **FOLDER_TO_DOWNLOAD_TO**, then a temporary folder is used.
898898

899-
Before creating or updating a resource, it is possible to specify the path to a local
900-
file to upload to the HDX filestore if that is preferred over hosting the file
901-
externally to HDX. Rather than the url of the resource pointing to your server or api,
902-
in this case the url will point to a location in the HDX filestore containing a copy of
903-
your file.
899+
Before creating or updating a resource by calling **create_in_hdx** or
900+
**update_in_hdx** on the resource or its parent dataset, it is possible to
901+
specify the path to a local file to upload to the HDX filestore if that is
902+
preferred over hosting the file externally to HDX. Rather than the url of the
903+
resource pointing to your server or api, in this case the url will point to a
904+
location in the HDX filestore containing a copy of your file.
904905

905906
resource.set_file_to_upload(file_to_upload="PATH_TO_FILE")
906907

907908
There is a getter to read the value back:
908909

909910
file_to_upload = resource.get_file_to_upload()
910911

911-
To indicate that the data in an external resource (given by a URL) has been
912-
updated, call **mark_data_updated** on the resource, before calling
913-
**create_in_hdx** or **update_in_hdx** on the dataset which will result in the
914-
resource `last_modified` field being set to now. Alternatively, when calling
915-
**create_in_hdx** or **update_in_hdx** on the resource, it is possible to
916-
supply the parameter `data_updated` eg.
912+
To indicate that the data in an externally hosted resource (given by a URL) has
913+
been updated, call **mark_data_updated** on the resource, before calling
914+
**create_in_hdx** or **update_in_hdx** on the resource or parent dataset which
915+
will result in the resource `last_modified` field being set to now.
916+
Alternatively, when calling **create_in_hdx** or **update_in_hdx** on the
917+
resource, it is possible to supply the parameter `data_updated` eg.
917918

918919
resource.update_in_hdx(data_updated=True)
919920

920921
If the method **set_file_to_upload** is used to supply a file, the resource
921922
`last_modified` field is set to now automatically regardless of the value of
922-
`data_updated`.
923+
`data_updated` or whether **mark_data_updated** has been called.
923924

924925
## Showcase Management
925926

0 commit comments

Comments
 (0)