Skip to content

Commit

Permalink
update command in docs and error message
Browse files Browse the repository at this point in the history
  • Loading branch information
vpchung committed Aug 3, 2023
1 parent 0eaff8a commit edbbfc0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion cli/medperf/comms/entity_resources/sources/synapse.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def authenticate(self):
except SynapseNoCredentialsError:
msg = "There was an attempt to download resources from the Synapse "
msg += "platform, but couldn't find Synapse credentials."
msg += "\nDid you run 'medperf synapse_login' before?"
msg += "\nDid you run 'medperf auth synapse_login' before?"
raise CommunicationAuthenticationError(msg)

def download(self, resource_identifier: str, output_path: str):
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/hosting_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ When your file is hosted on Synapse, MedPerf will be able to identify this file
--mlcube-file synapse:<the-synapse-id-of-the-file>
```

Note that you need to authenticate with your Synapse credentials if you plan to use a Synaspe file with MedPerf. To do so run `medperf synapse_login`.
Note that you need to authenticate with your Synapse credentials if you plan to use a Synaspe file with MedPerf. To do so run `medperf auth synapse_login`.

!!! note
You **must** authenticate if using files on Synapse. If this is not necessary, this means the file has anonymous public access read permission. In this case, Synapse allows you to generate a permanent direct download link for your file and you can follow the [previous section](#file-hosting).
Expand Down

0 comments on commit edbbfc0

Please sign in to comment.