Skip to content

Commit 857154e

Browse files
committed
Correct mis-spelled word
1 parent 728ec2b commit 857154e

30 files changed

+127
-127
lines changed

Diff for: synapseclient/api/annotations.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def set_annotations(
2626
and annotations filled in.
2727
synapse_client: If not passed in and caching was not disabled by
2828
`Synapse.allow_client_caching(False)` this will use the last created
29-
insance from the Synapse class constructor.
29+
instance from the Synapse class constructor.
3030
3131
Returns: The annotations set in Synapse.
3232
"""
@@ -61,7 +61,7 @@ async def set_annotations_async(
6161
and annotations filled in.
6262
synapse_client: If not passed in and caching was not disabled by
6363
`Synapse.allow_client_caching(False)` this will use the last created
64-
insance from the Synapse class constructor.
64+
instance from the Synapse class constructor.
6565
6666
Returns: The annotations set in Synapse.
6767
"""

Diff for: synapseclient/api/entity_bundle_services_v2.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ async def get_entity_id_bundle2(
2828
- includeRestrictionInformation: True
2929
synapse_client: If not passed in and caching was not disabled by
3030
`Synapse.allow_client_caching(False)` this will use the last created
31-
insance from the Synapse class constructor.
31+
instance from the Synapse class constructor.
3232
3333
Returns:
3434
The requested entity bundle matching
@@ -72,7 +72,7 @@ async def get_entity_id_version_bundle2(
7272
- includeRestrictionInformation: True
7373
synapse_client: If not passed in and caching was not disabled by
7474
`Synapse.allow_client_caching(False)` this will use the last created
75-
insance from the Synapse class constructor.
75+
instance from the Synapse class constructor.
7676
7777
Returns:
7878
The requested entity bundle matching
@@ -107,7 +107,7 @@ async def post_entity_bundle2_create(
107107
generated_by: The ID of the activity to associate with the entity.
108108
synapse_client: If not passed in and caching was not disabled by
109109
`Synapse.allow_client_caching(False)` this will use the last created
110-
insance from the Synapse class constructor.
110+
instance from the Synapse class constructor.
111111
112112
Returns:
113113
The requested entity bundle matching
@@ -138,7 +138,7 @@ async def put_entity_id_bundle2(
138138
generated_by: The ID of the activity to associate with the entity.
139139
synapse_client: If not passed in and caching was not disabled by
140140
`Synapse.allow_client_caching(False)` this will use the last created
141-
insance from the Synapse class constructor.
141+
instance from the Synapse class constructor.
142142
143143
Returns:
144144
The requested entity bundle matching

Diff for: synapseclient/api/entity_factory.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ async def get_from_entity_factory(
6161
Synapse.
6262
synapse_client: If not passed in and caching was not disabled by
6363
`Synapse.allow_client_caching(False)` this will use the last created
64-
insance from the Synapse class constructor.
64+
instance from the Synapse class constructor.
6565
6666
Example: Using this function
6767
Download file into cache
@@ -172,7 +172,7 @@ async def _search_for_file_by_md5(
172172
limit_search: Limit the search to a specific project or folder.
173173
synapse_client: If not passed in and caching was not disabled by
174174
`Synapse.allow_client_caching(False)` this will use the last created
175-
insance from the Synapse class constructor.
175+
instance from the Synapse class constructor.
176176
177177
Returns:
178178
A dictionary containing the entity bundle of the file found.
@@ -262,7 +262,7 @@ class type. This will also download the file if `download_file` is set to True.
262262
Synapse.
263263
synapse_client: If not passed in and caching was not disabled by
264264
`Synapse.allow_client_caching(False)` this will use the last created
265-
insance from the Synapse class constructor.
265+
instance from the Synapse class constructor.
266266
267267
Returns:
268268
A Synapse entity object.

Diff for: synapseclient/api/entity_services.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def post_entity(
2424
generated_by: The ID of the activity to associate with the entity.
2525
synapse_client: If not passed in and caching was not disabled by
2626
`Synapse.allow_client_caching(False)` this will use the last created
27-
insance from the Synapse class constructor.
27+
instance from the Synapse class constructor.
2828
2929
Returns:
3030
The requested entity matching
@@ -58,7 +58,7 @@ async def put_entity(
5858
generated_by: The ID of the activity to associate with the entity.
5959
synapse_client: If not passed in and caching was not disabled by
6060
`Synapse.allow_client_caching(False)` this will use the last created
61-
insance from the Synapse class constructor.
61+
instance from the Synapse class constructor.
6262
6363
Returns:
6464
The requested entity bundle matching
@@ -88,7 +88,7 @@ async def get_entity(
8888
entity_id: The ID of the entity.
8989
synapse_client: If not passed in and caching was not disabled by
9090
`Synapse.allow_client_caching(False)` this will use the last created
91-
insance from the Synapse class constructor.
91+
instance from the Synapse class constructor.
9292
9393
Returns:
9494
The requested entity bundle matching
@@ -118,7 +118,7 @@ async def get_upload_destination(
118118
entity_id: The ID of the entity.
119119
synapse_client: If not passed in and caching was not disabled by
120120
`Synapse.allow_client_caching(False)` this will use the last created
121-
insance from the Synapse class constructor.
121+
instance from the Synapse class constructor.
122122
123123
Returns:
124124
The upload destination.
@@ -144,7 +144,7 @@ async def get_upload_destination_location(
144144
location: A storage location ID of the upload destination.
145145
synapse_client: If not passed in and caching was not disabled by
146146
`Synapse.allow_client_caching(False)` this will use the last created
147-
insance from the Synapse class constructor.
147+
instance from the Synapse class constructor.
148148
149149
Returns:
150150
The upload destination.
@@ -169,7 +169,7 @@ async def create_access_requirements_if_none(
169169
entity_id: The ID of the entity.
170170
synapse_client: If not passed in and caching was not disabled by
171171
`Synapse.allow_client_caching(False)` this will use the last created
172-
insance from the Synapse class constructor.
172+
instance from the Synapse class constructor.
173173
"""
174174
from synapseclient import Synapse
175175

@@ -203,7 +203,7 @@ async def delete_entity_generated_by(
203203
entity_id: The ID of the entity.
204204
synapse_client: If not passed in and caching was not disabled by
205205
`Synapse.allow_client_caching(False)` this will use the last created
206-
insance from the Synapse class constructor.
206+
instance from the Synapse class constructor.
207207
208208
Returns: None
209209
"""
@@ -228,7 +228,7 @@ async def get_entity_path(
228228
entity_id: The ID of the entity.
229229
synapse_client: If not passed in and caching was not disabled by
230230
`Synapse.allow_client_caching(False)` this will use the last created
231-
insance from the Synapse class constructor.
231+
instance from the Synapse class constructor.
232232
233233
Returns:
234234
Entity paths matching:
@@ -255,7 +255,7 @@ async def get_entities_by_md5(
255255
md5: The MD5 of the entity.
256256
synapse_client: If not passed in and caching was not disabled by
257257
`Synapse.allow_client_caching(False)` this will use the last created
258-
insance from the Synapse class constructor.
258+
instance from the Synapse class constructor.
259259
260260
Returns:
261261
Paginated results of:

Diff for: synapseclient/api/file_services.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ async def post_file_multipart(
3838
endpoint: Server endpoint to call to.
3939
synapse_client: If not passed in and caching was not disabled by
4040
`Synapse.allow_client_caching(False)` this will use the last created
41-
insance from the Synapse class constructor.
41+
instance from the Synapse class constructor.
4242
4343
Returns:
4444
The requested multipart upload status matching
@@ -90,7 +90,7 @@ async def put_file_multipart_add(
9090
will fail.
9191
synapse_client: If not passed in and caching was not disabled by
9292
`Synapse.allow_client_caching(False)` this will use the last created
93-
insance from the Synapse class constructor.
93+
instance from the Synapse class constructor.
9494
9595
Returns:
9696
Object matching
@@ -130,7 +130,7 @@ async def put_file_multipart_complete(
130130
endpoint: Server endpoint to call to.
131131
synapse_client: If not passed in and caching was not disabled by
132132
`Synapse.allow_client_caching(False)` this will use the last created
133-
insance from the Synapse class constructor.
133+
instance from the Synapse class constructor.
134134
135135
Returns:
136136
Object matching
@@ -159,7 +159,7 @@ async def post_file_multipart_presigned_urls(
159159
part_numbers: The part numbers to get pre-signed URLs for.
160160
synapse_client: If not passed in and caching was not disabled by
161161
`Synapse.allow_client_caching(False)` this will use the last created
162-
insance from the Synapse class constructor.
162+
instance from the Synapse class constructor.
163163
164164
Returns:
165165
Object matching
@@ -205,7 +205,7 @@ async def post_external_object_store_filehandle(
205205
md5: The file's content MD5, if known.
206206
synapse_client: If not passed in and caching was not disabled by
207207
`Synapse.allow_client_caching(False)` this will use the last created
208-
insance from the Synapse class constructor.
208+
instance from the Synapse class constructor.
209209
210210
Returns:
211211
A FileHandle for objects that are stored externally.
@@ -250,7 +250,7 @@ async def post_external_filehandle(
250250
file_size: The size of the file in bytes.
251251
synapse_client: If not passed in and caching was not disabled by
252252
`Synapse.allow_client_caching(False)` this will use the last created
253-
insance from the Synapse class constructor.
253+
instance from the Synapse class constructor.
254254
255255
Returns:
256256
A FileHandle for objects that are stored externally.
@@ -307,7 +307,7 @@ async def post_external_s3_file_handle(
307307
md5: MD5 of the file, if known
308308
synapse_client: If not passed in and caching was not disabled by
309309
`Synapse.allow_client_caching(False)` this will use the last created
310-
insance from the Synapse class constructor.
310+
instance from the Synapse class constructor.
311311
312312
Returns:
313313
The created file handle.
@@ -369,7 +369,7 @@ async def get_file_handle(
369369
file_handle_id: The ID of the file handle to look up.
370370
synapse_client: If not passed in and caching was not disabled by
371371
`Synapse.allow_client_caching(False)` this will use the last created
372-
insance from the Synapse class constructor.
372+
instance from the Synapse class constructor.
373373
374374
Returns:
375375
A file handle retrieved from the file handle service.
@@ -402,7 +402,7 @@ async def get_file_handle_for_download_async(
402402
<https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/FileHandleAssociateType.html>
403403
synapse_client: If not passed in and caching was not disabled by
404404
`Synapse.allow_client_caching(False)` this will use the last created
405-
insance from the Synapse class constructor.
405+
instance from the Synapse class constructor.
406406
407407
Raises:
408408
SynapseFileNotFoundError: If the fileHandleId is not found in Synapse.
@@ -463,7 +463,7 @@ def get_file_handle_for_download(
463463
<https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/FileHandleAssociateType.html>
464464
synapse_client: If not passed in and caching was not disabled by
465465
`Synapse.allow_client_caching(False)` this will use the last created
466-
insance from the Synapse class constructor.
466+
instance from the Synapse class constructor.
467467
468468
Raises:
469469
SynapseFileNotFoundError: If the fileHandleId is not found in Synapse.

Diff for: synapseclient/core/download/download_functions.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ async def download_file_entity(
9999
submission: Access associated files through a submission rather than through an entity.
100100
synapse_client: If not passed in and caching was not disabled by
101101
`Synapse.allow_client_caching(False)` this will use the last created
102-
insance from the Synapse class constructor.
102+
instance from the Synapse class constructor.
103103
"""
104104
from synapseclient import Synapse
105105

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

@@ -320,7 +320,7 @@ async def download_by_file_handle(
320320
retries: The Number of download retries attempted before throwing an exception.
321321
synapse_client: If not passed in and caching was not disabled by
322322
`Synapse.allow_client_caching(False)` this will use the last created
323-
insance from the Synapse class constructor.
323+
instance from the Synapse class constructor.
324324
325325
Returns:
326326
The path to downloaded file
@@ -579,7 +579,7 @@ async def download_from_url_multi_threaded(
579579
content_size: The size of the content
580580
synapse_client: If not passed in and caching was not disabled by
581581
`Synapse.allow_client_caching(False)` this will use the last created
582-
insance from the Synapse class constructor.
582+
instance from the Synapse class constructor.
583583
Raises:
584584
SynapseMd5MismatchError: If the actual MD5 does not match expected MD5.
585585
@@ -650,7 +650,7 @@ def download_from_url(
650650
expected_md5: Optional. If given, check that the MD5 of the downloaded file matches the expected MD5
651651
synapse_client: If not passed in and caching was not disabled by
652652
`Synapse.allow_client_caching(False)` this will use the last created
653-
insance from the Synapse class constructor.
653+
instance from the Synapse class constructor.
654654
655655
Raises:
656656
IOError: If the local file does not exist.

Diff for: synapseclient/core/transfer_bar.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def shared_download_progress_bar(
7575
file_size: The size of the file being downloaded.
7676
synapse_client: If not passed in and caching was not disabled by
7777
`Synapse.allow_client_caching(False)` this will use the last created
78-
insance from the Synapse class constructor.
78+
instance from the Synapse class constructor.
7979
8080
Yields:
8181
A context manager that will handle the download progress bar.

Diff for: synapseclient/models/activity.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ async def store_async(
271271
parent: The parent entity to associate this activity with.
272272
synapse_client: If not passed in and caching was not disabled by
273273
`Synapse.allow_client_caching(False)` this will use the last created
274-
insance from the Synapse class constructor.
274+
instance from the Synapse class constructor.
275275
276276
Returns:
277277
The activity object.
@@ -341,7 +341,7 @@ async def from_parent_async(
341341
omitted.
342342
synapse_client: If not passed in and caching was not disabled by
343343
`Synapse.allow_client_caching(False)` this will use the last created
344-
insance from the Synapse class constructor.
344+
instance from the Synapse class constructor.
345345
346346
Returns:
347347
The activity object or None if it does not exist.
@@ -391,7 +391,7 @@ async def delete_async(
391391
parent: The parent entity this activity is associated with.
392392
synapse_client: If not passed in and caching was not disabled by
393393
`Synapse.allow_client_caching(False)` this will use the last created
394-
insance from the Synapse class constructor.
394+
instance from the Synapse class constructor.
395395
396396
Raises:
397397
ValueError: If the parent does not have an ID.
@@ -427,7 +427,7 @@ async def disassociate_from_entity_async(
427427
parent: The parent entity this activity is associated with.
428428
synapse_client: If not passed in and caching was not disabled by
429429
`Synapse.allow_client_caching(False)` this will use the last created
430-
insance from the Synapse class constructor.
430+
instance from the Synapse class constructor.
431431
432432
Raises:
433433
ValueError: If the parent does not have an ID.

Diff for: synapseclient/models/annotations.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ async def store_async(
7070
Arguments:
7171
synapse_client: If not passed in and caching was not disabled by
7272
`Synapse.allow_client_caching(False)` this will use the last created
73-
insance from the Synapse class constructor.
73+
instance from the Synapse class constructor.
7474
7575
Returns:
7676
The stored annotations.

0 commit comments

Comments
 (0)