Skip to content

Commit

Permalink
formats long lines for walk_functions
Browse files Browse the repository at this point in the history
  • Loading branch information
BWMac committed Dec 22, 2023
1 parent d042db5 commit f9bba30
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions synapseutils/walk_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ def walk(
],
):
"""
Traverse through the hierarchy of files and folders stored under the synId. Has the same behavior as os.walk()
Traverse through the hierarchy of files and folders stored under the synId.
Has the same behavior as os.walk()
Arguments:
syn: A Synapse object with user's login, e.g. syn = synapseclient.login()
Expand Down Expand Up @@ -57,8 +58,8 @@ def _helpWalk(
syn: A synapse object: syn = synapseclient.login()- Must be logged into synapse
synId: A synapse ID of a folder or project
includeTypes: Must be a list of entity types (ie. ["file", "table"]) which can be found here:
http://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/EntityType.html
The "folder" type is always included so the hierarchy can be traversed
http://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/EntityType.html
The "folder" type is always included so the hierarchy can be traversed
newpath: The directory path of the listed files
"""
starting = syn.get(synId, downloadFile=False)
Expand Down

0 comments on commit f9bba30

Please sign in to comment.