Skip to content

Change the param directive to keyword in docstrings #7855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rakshith91 merged 2 commits into from
Oct 14, 2019
Merged

Change the param directive to keyword in docstrings #7855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2d47dc
Change the directive to keyword in docstrings
rakshith91 Oct 12, 2019
299527c
pylint :(
rakshith91 Oct 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
420 changes: 210 additions & 210 deletions sdk/storage/azure-storage-blob/azure/storage/blob/aio/blob_client_async.py
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions sdk/storage/azure-storage-blob/azure/storage/blob/aio/blob_service_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ async def get_user_delegation_key(self, key_start_time, # type: datetime
A DateTime value. Indicates when the key becomes valid.
:param ~datetime.datetime key_expiry_time:
A DateTime value. Indicates when the key stops being valid.
:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:return: The user delegation key.
:rtype: ~azure.storage.blob.UserDelegationKey
Expand Down Expand Up @@ -187,7 +187,7 @@ async def get_service_stats(self, **kwargs): # type: ignore
access is available from the secondary location, if read-access geo-redundant
replication is enabled for your storage account.

:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:return: The blob service stats.
:rtype: ~azure.storage.blob._generated.models.StorageServiceStats
Expand All @@ -214,7 +214,7 @@ async def get_service_properties(self, **kwargs):
"""Gets the properties of a storage account's Blob service, including
Azure Storage Analytics.

:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: ~azure.storage.blob._generated.models.StorageServiceProperties

Expand Down Expand Up @@ -278,7 +278,7 @@ async def set_service_properties(
Specifies whether the static website feature is enabled,
and if yes, indicates the index document and 404 error document to use.
:type static_website: ~azure.storage.blob.StaticWebsite
:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: None

Expand Down Expand Up @@ -327,7 +327,7 @@ def list_containers(
:param int results_per_page:
The maximum number of container names to retrieve per API
call. If the request does not specify the server will return up to 5,000 items.
:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: An iterable (auto-paging) of ContainerProperties.
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.ContainerProperties]
Expand Down Expand Up @@ -379,7 +379,7 @@ async def create_container(
:param public_access:
Possible values include: container, blob.
:type public_access: str or ~azure.storage.blob.PublicAccess
:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: ~azure.storage.blob.aio.ContainerClient

Expand Down Expand Up @@ -419,28 +419,28 @@ async def delete_container(
If specified, delete_container only succeeds if the
container's lease is active and matches this ID.
Required if the container has an active lease.
:param ~datetime.datetime if_modified_since:
:keyword ~datetime.datetime if_modified_since:
A DateTime value. Azure expects the date value passed in to be UTC.
If timezone is included, any non-UTC datetimes will be converted to UTC.
If a date is passed in without timezone info, it is assumed to be UTC.
Specify this header to perform the operation only
if the resource has been modified since the specified time.
:param ~datetime.datetime if_unmodified_since:
:keyword ~datetime.datetime if_unmodified_since:
A DateTime value. Azure expects the date value passed in to be UTC.
If timezone is included, any non-UTC datetimes will be converted to UTC.
If a date is passed in without timezone info, it is assumed to be UTC.
Specify this header to perform the operation only if
the resource has not been modified since the specified date/time.
:param str if_match:
:keyword str if_match:
An ETag value, or the wildcard character (*). Specify this header to perform
the operation only if the resource's ETag matches the value specified.
:param str if_none_match:
:keyword str if_none_match:
An ETag value, or the wildcard character (*). Specify this header
to perform the operation only if the resource's ETag does not match
the value specified. Specify the wildcard character (*) to perform
the operation only if the resource does not exist, and fail the
operation if it does exist.
:param int timeout:
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: None

Expand Down
Loading