Skip to content

Commit 4d19710

Browse files
committed
Add clarifying comments to the docstrings for shared link methods.
1 parent 07353ae commit 4d19710

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

boxsdk/object/file.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,7 @@ def get_shared_link_download_url(
248248
):
249249
"""
250250
Get a shared link download url for the file with the given access permissions.
251+
This url is a direct download url for the file.
251252
252253
:param access:
253254
Determines who can access the shared link. May be open, company, or collaborators. If no access is

boxsdk/object/item.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ def get_shared_link(
239239
):
240240
"""
241241
Get a shared link for the item with the given access permissions.
242+
This url leads to a Box.com shared link page, where the item can be previewed, downloaded, etc.
242243
243244
:param access:
244245
Determines who can access the shared link. May be open, company, or collaborators. If no access is

0 commit comments

Comments
 (0)