Skip to content
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

Jump to bottom

class links with extra text need :class: #7215

Merged
merged 2 commits into from
Sep 12, 2019
Merged

class links with extra text need :class: #7215

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7c28cc
class links with extra text need :class:
bryevdv Sep 11, 2019
4a436eb
use explicit syntax in azure-keyvault-certificates
chlowell Sep 12, 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
10 changes: 5 additions & 5 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ async def delete_key(self, name: str, **kwargs: "**Any") -> DeletedKey:
:param str name: The name of the key to delete.
:returns: The deleted key
:rtype: ~azure.keyvault.keys.models.DeletedKey
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys_async.py
Expand All @@ -225,7 +225,7 @@ async def get_key(self, name: str, version: Optional[str] = None, **kwargs: "**A
:param str version: (optional) A specific version of the key to get. If not specified, gets the latest version
of the key.
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys_async.py
Expand Down Expand Up @@ -405,7 +405,7 @@ async def update_key(
:param dict tags: (optional) Application specific metadata in the form of key-value pairs
:returns: The updated key
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys_async.py
Expand Down Expand Up @@ -443,7 +443,7 @@ async def backup_key(self, name: str, **kwargs: "**Any") -> bytes:
:param str name: The name of the key
:returns: The raw bytes of the key backup
:rtype: bytes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys_async.py
Expand All @@ -469,7 +469,7 @@ async def restore_key(self, backup: bytes, **kwargs: "**Any") -> Key:
:param bytes backup: The raw bytes of the key backup
:returns: The restored key
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceExistsError if the backed up key's name is already in use
:raises: :class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use

Example:
.. literalinclude:: ../tests/test_samples_keys_async.py
Expand Down
10 changes: 5 additions & 5 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def delete_key(self, name, **kwargs):
:param str name: The name of the key to delete.
:returns: The deleted key
:rtype: ~azure.keyvault.keys.models.DeletedKey
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys.py
Expand All @@ -240,7 +240,7 @@ def get_key(self, name, version=None, **kwargs):
:param str version: (optional) A specific version of the key to get. If not specified, gets the latest version
of the key.
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys.py
Expand Down Expand Up @@ -431,7 +431,7 @@ def update_key(
:param dict tags: (optional) Application specific metadata in the form of key-value pairs
:returns: The updated key
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys.py
Expand Down Expand Up @@ -469,7 +469,7 @@ def backup_key(self, name, **kwargs):
:param str name: The name of the key
:returns: The raw bytes of the key backup
:rtype: bytes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the key doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_keys.py
Expand All @@ -494,7 +494,7 @@ def restore_key(self, backup, **kwargs):
:param bytes backup: The raw bytes of the key backup
:returns: The restored key
:rtype: ~azure.keyvault.keys.models.Key
:raises: ~azure.core.exceptions.ResourceExistsError if the backed up key's name is already in use
:raises: :class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use

Example:
.. literalinclude:: ../tests/test_samples_keys.py
Expand Down
12 changes: 6 additions & 6 deletions sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ async def get_secret(self, name: str, version: Optional[str] = None, **kwargs: "
:param str name: The name of the secret
:param str version: (optional) Version of the secret to get. If unspecified, gets the latest version.
:rtype: ~azure.keyvault.secrets.models.Secret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand Down Expand Up @@ -118,7 +118,7 @@ async def update_secret(
:param datetime.datetime expires: (optional) Expiry date of the secret in UTC.
:param dict(str, str) tags: (optional) Application specific metadata in the form of key-value pairs.
:rtype: ~azure.keyvault.secrets.models.SecretAttributes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand Down Expand Up @@ -201,7 +201,7 @@ async def backup_secret(self, name: str, **kwargs: "**Any") -> bytes:
:param str name: Name of the secret
:returns: The raw bytes of the secret backup
:rtype: bytes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand All @@ -223,7 +223,7 @@ async def restore_secret(self, backup: bytes, **kwargs: "**Any") -> SecretAttrib
:param bytes backup: The raw bytes of the secret backup
:returns: The restored secret
:rtype: ~azure.keyvault.secrets.models.SecretAttributes
:raises: ~azure.core.exceptions.ResourceExistsError if the secret's name is already in use
:raises: :class:`~azure.core.exceptions.ResourceExistsError` if the secret's name is already in use

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand All @@ -244,7 +244,7 @@ async def delete_secret(self, name: str, **kwargs: "**Any") -> DeletedSecret:

:param str name: Name of the secret
:rtype: ~azure.keyvault.secrets.models.DeletedSecret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand All @@ -266,7 +266,7 @@ async def get_deleted_secret(self, name: str, **kwargs: "**Any") -> DeletedSecre

:param str name: Name of the secret
:rtype: ~azure.keyvault.secrets.models.DeletedSecret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the deleted secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the deleted secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
Expand Down
12 changes: 6 additions & 6 deletions sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def get_secret(self, name, version=None, **kwargs):
:param str name: The name of the secret
:param str version: (optional) Version of the secret to get. If unspecified, gets the latest version.
:rtype: ~azure.keyvault.secrets.models.Secret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand Down Expand Up @@ -139,7 +139,7 @@ def update_secret(
:param datetime.datetime expires: (optional) Expiry date of the secret in UTC.
:param dict tags: (optional) Application specific metadata in the form of key-value pairs
:rtype: ~azure.keyvault.secrets.models.SecretAttributes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand Down Expand Up @@ -228,7 +228,7 @@ def backup_secret(self, name, **kwargs):
:param str name: Name of the secret
:returns: The raw bytes of the secret backup
:rtype: bytes
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand All @@ -252,7 +252,7 @@ def restore_secret(self, backup, **kwargs):
:param bytes backup: The raw bytes of the secret backup
:returns: The restored secret
:rtype: ~azure.keyvault.secrets.models.SecretAttributes
:raises: ~azure.core.exceptions.ResourceExistsError if the secret's name is already in use
:raises: :class:`~azure.core.exceptions.ResourceExistsError` if the secret's name is already in use

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand All @@ -273,7 +273,7 @@ def delete_secret(self, name, **kwargs):

:param str name: Name of the secret
:rtype: ~azure.keyvault.secrets.models.DeletedSecret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand All @@ -295,7 +295,7 @@ def get_deleted_secret(self, name, **kwargs):

:param str name: Name of the secret
:rtype: ~azure.keyvault.secrets.models.DeletedSecret
:raises: ~azure.core.exceptions.ResourceNotFoundError if the deleted secret doesn't exist
:raises: :class:`~azure.core.exceptions.ResourceNotFoundError` if the deleted secret doesn't exist

Example:
.. literalinclude:: ../tests/test_samples_secrets.py
Expand Down