[SYNPY-1508]: add tutorial for downloading files by Synapse ID concurrenty#1337
[SYNPY-1508]: add tutorial for downloading files by Synapse ID concurrenty#1337thomasyu888 merged 6 commits intodevelopfrom
Conversation
…ntly Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
linglp
left a comment
There was a problem hiding this comment.
LGTM! I tested out the script, and it worked.
There was a problem hiding this comment.
Pull request overview
Adds a new Python tutorial page and accompanying script to demonstrate downloading a set of Synapse Files by Synapse ID concurrently, and wires the new tutorial into the docs navigation.
Changes:
- Add a new tutorial page for downloading files by Synapse ID using the async API.
- Add the corresponding tutorial script that concurrently downloads multiple files via
File.get_async()+asyncio.gather. - Link the tutorial from
mkdocs.ymlnav and the Python tutorial index page.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds the new tutorial page to the MkDocs navigation. |
| docs/tutorials/python/tutorial_scripts/download_data_by_synid.py | New example script demonstrating concurrent downloads by Synapse ID. |
| docs/tutorials/python/download_data_by_synid.md | New tutorial documentation page referencing the script snippets and full source. |
| docs/tutorials/python_client.md | Adds a bullet linking to the new tutorial from the Python tutorials landing page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,66 @@ | |||
| [](){ #tutorial-downloading-a-file } | |||
There was a problem hiding this comment.
The page anchor id (tutorial-downloading-a-file) doesn’t match this tutorial’s topic/filename (downloading by Synapse ID). This looks like a copy/paste and makes reference-style links confusing/hard to add later. Please update the anchor to a unique, descriptive id (e.g., tutorial-downloading-data-by-synapse-id).
| [](){ #tutorial-downloading-a-file } | |
| [](){ #tutorial-downloading-data-by-synapse-id } |
| @@ -0,0 +1,43 @@ | |||
| """ | |||
| Here is where you'll find the code for the downloading files by synapse ids tutorial. | |||
There was a problem hiding this comment.
Docstring wording/capitalization is inconsistent with the rest of the docs ("Synapse IDs"); consider revising to use proper capitalization and clearer phrasing (e.g., "...downloading files by Synapse ID(s) tutorial").
| Here is where you'll find the code for the downloading files by synapse ids tutorial. | |
| Code for the downloading files by Synapse ID(s) tutorial. |
Problem:
No tutorial for downloading one file or set of files
Solution:
Add tutorial
Testing:
https://synapsepythonclient--1337.org.readthedocs.build/en/1337/