Skip to content
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.

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

BUG:Link to sync documentation in commandline and python are the same while the interface is different #798

Open
1 task done
larssono opened this issue Jul 15, 2020 · 0 comments
Labels

Comments

@larssono
Copy link
Collaborator

  • [ x] I have checked the existing issues to confirm it has not already been reported.

  • I have confirmed this bug exists on the latest version of Synapse Documentation.


Problem Description

The bulk uploading information for the Python client and Commanline link to the same location while the commandline uses the synapse sync while the python client uses syn.syncToSynapse. The link can't be the same. Specifically the current page says:

Validate the Manifest and Upload Files
The format of the manifest file (called ‘filesToUpload.tsv’ in this example) can be validated prior to upload by using the parameter dryRun in syncToSynapse. dryRun will not upload the data specified in the manifest file. Instead, the client checks the manifest file format, all file paths exist, all files are unique, Provenance can be set (optional) and the parent synId exists. The number of files and total upload size is also summarized in the dryRun output. This helps ensure your data upload does not end prematurely due to a typo in the file path or parent synId.

validate the manifest in the Python client or command line.

The last section part " Python client or command line." links to the same place and that place has no information about the Sync commands.

[Explain why the current behaviour is a problem and why the proposed change is a better solution.]

Proposed Change

@larssono larssono added the bug label Jul 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant