Skip to content

Commit fcf371f

Browse files
authored
[SYNPY-1702] Update curator extensions related documentation (#1312)
* [SYNPY-1702] Clarify folder_id comment in metadata_curation.md Clarify folder_id comment in metadata_curation * Change this to False * Update documentation
1 parent 03e14b6 commit fcf371f

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/guides/extensions/curator/metadata_curation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Use this when metadata describes individual data files and is stored as annotati
7373
record_set, curation_task, data_grid = create_record_based_metadata_task(
7474
synapse_client=syn,
7575
project_id="syn123456789", # Your project ID
76-
folder_id="syn987654321", # Folder where files are stored
76+
folder_id="syn987654321", # Folder where RecordSet Entity will be stored
7777
record_set_name="AnimalMetadata_Records",
7878
record_set_description="Centralized metadata for animal study data",
7979
curation_task_name="AnimalMetadata_Curation", # Must be unique within the project
@@ -104,7 +104,7 @@ entity_view_id, task_id = create_file_based_metadata_task(
104104
folder_id="syn987654321", # Folder containing your data files
105105
curation_task_name="FileMetadata_Curation", # Must be unique within the project
106106
instructions="Annotate each file with metadata according to the schema requirements.",
107-
attach_wiki=True, # Creates a wiki in the folder with the entity view (Defaults to False)
107+
attach_wiki=False, # Creates a wiki in the folder with the entity view (Defaults to False)
108108
entity_view_name="Animal Study Files View",
109109
schema_uri=schema_uri # Schema found in Step 2
110110
)

synapseclient/extensions/curator/record_based_metadata_task.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def create_record_based_metadata_task(
154154
155155
Arguments:
156156
project_id: The Synapse ID of the project where the folder exists.
157-
folder_id: The Synapse ID of the folder to upload to.
157+
folder_id: The Synapse ID of the folder to upload RecordSet to.
158158
record_set_name: Name for the RecordSet.
159159
record_set_description: Description for the RecordSet.
160160
curation_task_name: Name for the CurationTask (used as data_type field).

0 commit comments

Comments
 (0)