Skip to content

Commit

Permalink
Correct mis-spelled word
Browse files Browse the repository at this point in the history
  • Loading branch information
BryanFauble committed Sep 19, 2024
1 parent 728ec2b commit 857154e
Show file tree
Hide file tree
Showing 30 changed files with 127 additions and 127 deletions.
4 changes: 2 additions & 2 deletions synapseclient/api/annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def set_annotations(
and annotations filled in.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns: The annotations set in Synapse.
"""
Expand Down Expand Up @@ -61,7 +61,7 @@ async def set_annotations_async(
and annotations filled in.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns: The annotations set in Synapse.
"""
Expand Down
8 changes: 4 additions & 4 deletions synapseclient/api/entity_bundle_services_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ async def get_entity_id_bundle2(
- includeRestrictionInformation: True
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down Expand Up @@ -72,7 +72,7 @@ async def get_entity_id_version_bundle2(
- includeRestrictionInformation: True
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down Expand Up @@ -107,7 +107,7 @@ async def post_entity_bundle2_create(
generated_by: The ID of the activity to associate with the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down Expand Up @@ -138,7 +138,7 @@ async def put_entity_id_bundle2(
generated_by: The ID of the activity to associate with the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down
6 changes: 3 additions & 3 deletions synapseclient/api/entity_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ async def get_from_entity_factory(
Synapse.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Example: Using this function
Download file into cache
Expand Down Expand Up @@ -172,7 +172,7 @@ async def _search_for_file_by_md5(
limit_search: Limit the search to a specific project or folder.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
A dictionary containing the entity bundle of the file found.
Expand Down Expand Up @@ -262,7 +262,7 @@ class type. This will also download the file if `download_file` is set to True.
Synapse.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
A Synapse entity object.
Expand Down
18 changes: 9 additions & 9 deletions synapseclient/api/entity_services.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ async def post_entity(
generated_by: The ID of the activity to associate with the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity matching
Expand Down Expand Up @@ -58,7 +58,7 @@ async def put_entity(
generated_by: The ID of the activity to associate with the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down Expand Up @@ -88,7 +88,7 @@ async def get_entity(
entity_id: The ID of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested entity bundle matching
Expand Down Expand Up @@ -118,7 +118,7 @@ async def get_upload_destination(
entity_id: The ID of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The upload destination.
Expand All @@ -144,7 +144,7 @@ async def get_upload_destination_location(
location: A storage location ID of the upload destination.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The upload destination.
Expand All @@ -169,7 +169,7 @@ async def create_access_requirements_if_none(
entity_id: The ID of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
"""
from synapseclient import Synapse

Expand Down Expand Up @@ -203,7 +203,7 @@ async def delete_entity_generated_by(
entity_id: The ID of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns: None
"""
Expand All @@ -228,7 +228,7 @@ async def get_entity_path(
entity_id: The ID of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
Entity paths matching:
Expand All @@ -255,7 +255,7 @@ async def get_entities_by_md5(
md5: The MD5 of the entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
Paginated results of:
Expand Down
20 changes: 10 additions & 10 deletions synapseclient/api/file_services.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ async def post_file_multipart(
endpoint: Server endpoint to call to.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The requested multipart upload status matching
Expand Down Expand Up @@ -90,7 +90,7 @@ async def put_file_multipart_add(
will fail.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
Object matching
Expand Down Expand Up @@ -130,7 +130,7 @@ async def put_file_multipart_complete(
endpoint: Server endpoint to call to.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
Object matching
Expand Down Expand Up @@ -159,7 +159,7 @@ async def post_file_multipart_presigned_urls(
part_numbers: The part numbers to get pre-signed URLs for.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
Object matching
Expand Down Expand Up @@ -205,7 +205,7 @@ async def post_external_object_store_filehandle(
md5: The file's content MD5, if known.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
A FileHandle for objects that are stored externally.
Expand Down Expand Up @@ -250,7 +250,7 @@ async def post_external_filehandle(
file_size: The size of the file in bytes.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
A FileHandle for objects that are stored externally.
Expand Down Expand Up @@ -307,7 +307,7 @@ async def post_external_s3_file_handle(
md5: MD5 of the file, if known
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The created file handle.
Expand Down Expand Up @@ -369,7 +369,7 @@ async def get_file_handle(
file_handle_id: The ID of the file handle to look up.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
A file handle retrieved from the file handle service.
Expand Down Expand Up @@ -402,7 +402,7 @@ async def get_file_handle_for_download_async(
<https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/FileHandleAssociateType.html>
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
SynapseFileNotFoundError: If the fileHandleId is not found in Synapse.
Expand Down Expand Up @@ -463,7 +463,7 @@ def get_file_handle_for_download(
<https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/FileHandleAssociateType.html>
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
SynapseFileNotFoundError: If the fileHandleId is not found in Synapse.
Expand Down
10 changes: 5 additions & 5 deletions synapseclient/core/download/download_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ async def download_file_entity(
submission: Access associated files through a submission rather than through an entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
"""
from synapseclient import Synapse

Expand Down Expand Up @@ -212,7 +212,7 @@ async def download_file_entity_model(
submission: Access associated files through a submission rather than through an entity.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
"""
from synapseclient import Synapse

Expand Down Expand Up @@ -320,7 +320,7 @@ async def download_by_file_handle(
retries: The Number of download retries attempted before throwing an exception.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The path to downloaded file
Expand Down Expand Up @@ -579,7 +579,7 @@ async def download_from_url_multi_threaded(
content_size: The size of the content
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
SynapseMd5MismatchError: If the actual MD5 does not match expected MD5.
Expand Down Expand Up @@ -650,7 +650,7 @@ def download_from_url(
expected_md5: Optional. If given, check that the MD5 of the downloaded file matches the expected MD5
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
IOError: If the local file does not exist.
Expand Down
2 changes: 1 addition & 1 deletion synapseclient/core/transfer_bar.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def shared_download_progress_bar(
file_size: The size of the file being downloaded.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Yields:
A context manager that will handle the download progress bar.
Expand Down
8 changes: 4 additions & 4 deletions synapseclient/models/activity.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ async def store_async(
parent: The parent entity to associate this activity with.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The activity object.
Expand Down Expand Up @@ -341,7 +341,7 @@ async def from_parent_async(
omitted.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The activity object or None if it does not exist.
Expand Down Expand Up @@ -391,7 +391,7 @@ async def delete_async(
parent: The parent entity this activity is associated with.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
ValueError: If the parent does not have an ID.
Expand Down Expand Up @@ -427,7 +427,7 @@ async def disassociate_from_entity_async(
parent: The parent entity this activity is associated with.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Raises:
ValueError: If the parent does not have an ID.
Expand Down
2 changes: 1 addition & 1 deletion synapseclient/models/annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ async def store_async(
Arguments:
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
insance from the Synapse class constructor.
instance from the Synapse class constructor.
Returns:
The stored annotations.
Expand Down
Loading

0 comments on commit 857154e

Please sign in to comment.