Skip to content

fix typo in changeFileMetaData docstring (SYNPY-680) #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2020
Merged

fix typo in changeFileMetaData docstring (SYNPY-680) #731

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions synapseutils/copy_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,11 @@ def changeFileMetaData(syn, entity, downloadAs=None, contentType=None):

:return: Synapse Entity

Can be used to change the fileaname or the file content-type without downloading::
Can be used to change the filename or the file content-type without downloading::

e = syn.get(synid)
print(os.path.basename(e.path)) ## prints, e.g., "my_file.txt"
e = synapseutils.changeFileMetaData(syn, e, "my_newname_file.txt")
file_entity = syn.get(synid)
print(os.path.basename(file_entity.path)) ## prints, e.g., "my_file.txt"
file_entity = synapseutils.changeFileMetaData(syn, file_entity, "my_new_name_file.txt")
"""
ent = syn.get(entity, downloadFile=False)
fileResult = syn._getFileHandleDownload(ent.dataFileHandleId, ent.id)
Expand Down