class links with extra text need :class: (#7215)

* class links with extra text need :class: * use explicit syntax in azure-keyvault-certificates
Azure · Sep 12, 2019 · d1cf7e2 · d1cf7e2
1 parent 71c31c4
commit d1cf7e2
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 80 deletions.
diff --git a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/aio/client.py
@@ -67,7 +67,7 @@ async def create_certificate(
         :type tags: dict(str, str)
         :returns: The created CertificateOperation
         :rtype: coroutine
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -148,7 +148,7 @@ async def get_certificate_with_policy(
         :param str name: The name of the certificate in the given vault.
         :returns: An instance of Certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -182,7 +182,7 @@ async def get_certificate(
         :param str version: The version of the certificate.
         :returns: An instance of Certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -212,7 +212,7 @@ async def delete_certificate(self, name: str, **kwargs: "**Any") -> DeletedCerti
         :param str name: The name of the certificate.
         :returns: The deleted certificate
         :rtype: ~azure.keyvault.certificates.models.DeletedCertificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -241,7 +241,7 @@ async def get_deleted_certificate(self, name: str, **kwargs: "**Any") -> Deleted
         :param str name: The name of the certificate.
         :return: The deleted certificate
         :rtype: ~azure.keyvault.certificates.models.DeletedCertificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -270,7 +270,7 @@ async def purge_deleted_certificate(self, name: str, **kwargs: "**Any") -> None:
         :param str name: The name of the certificate
         :return: None
         :rtype: None
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         await self._client.purge_deleted_certificate(
             vault_base_url=self.vault_url,
@@ -291,7 +291,7 @@ async def recover_deleted_certificate(self, name: str, **kwargs: "**Any") -> Cer
         :param str name: The name of the deleted certificate
         :return: The recovered certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -340,7 +340,7 @@ async def import_certificate(
         :type tags: dict[str, str]
         :returns: The imported Certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         if enabled is not None:
             attributes = self._client.models.CertificateAttributes(
@@ -371,7 +371,7 @@ async def get_policy(self, name: str, **kwargs: "**Any") -> CertificatePolicy:
         :param str name: The name of the certificate in a given key vault.
         :return: The certificate policy
         :rtype: ~azure.keyvault.certificates.models.CertificatePolicy
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         bundle = await self._client.get_certificate_policy(
             vault_base_url=self.vault_url,
@@ -397,7 +397,7 @@ async def update_policy(
         :type policy: ~azure.keyvault.certificates.models.CertificatePolicy
         :return: The certificate policy
         :rtype: ~azure.keyvault.certificates.models.CertificatePolicy
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         bundle = await self._client.update_certificate_policy(
             vault_base_url=self.vault_url,
@@ -429,7 +429,7 @@ async def update_certificate(
         :type tags: dict(str, str)
         :returns: The updated Certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -467,7 +467,7 @@ async def backup_certificate(self, name: str, **kwargs: "**Any") -> bytes:
         :param str name: The name of the certificate.
         :return: the backup blob containing the backed up certificate.
         :rtype: bytes
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -494,7 +494,7 @@ async def restore_certificate(self, backup: bytes, **kwargs: "**Any") -> Certifi
         :param bytes backup: The backup blob associated with a certificate bundle.
         :return: The restored Certificate
         :rtype: ~azure.keyvault.certificates.models.Certificate
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -530,7 +530,7 @@ def list_deleted_certificates(
         :return: An iterator like instance of DeletedCertificate
         :rtype:
          ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.DeletedCertificate]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -566,7 +566,7 @@ def list_certificates(
         :returns: An iterator like instance of CertificateBase
         :rtype:
          ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -597,7 +597,7 @@ def list_certificate_versions(self, name: str, **kwargs: "**Any") -> AsyncIterab
         :returns: An iterator like instance of CertificateBase
         :rtype:
          ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.CertificateBase]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -630,7 +630,7 @@ async def create_contacts(self, contacts: Iterable[Contact], **kwargs: "**Any")
         :type contacts: list[~azure.keyvault.certificates.models.Contact]
         :returns: The created list of contacts
         :rtype: list[~azure.keyvault.certificates.models.Contact]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -661,7 +661,7 @@ async def get_contacts(self, **kwargs: "**Any") -> List[Contact]:
 
         :return: The certificate contacts for the key vault.
         :rtype: list[azure.keyvault.certificates.models.Contact]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -687,7 +687,7 @@ async def delete_contacts(self, **kwargs: "**Any") -> List[Contact]:
 
         :return: Contacts
         :rtype: list[~azure.keyvault.certificates.models.Contact]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -710,7 +710,7 @@ async def get_certificate_operation(self, name: str, **kwargs: "**Any") -> Certi
         :param str name: The name of the certificate.
         :returns: The created CertificateOperation
         :rtype: ~azure.keyvault.certificates.models.CertificateOperation
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
 
         bundle = await self._client.get_certificate_operation(
@@ -731,7 +731,7 @@ async def delete_certificate_operation(self, name: str, **kwargs: "**Any") -> Ce
         :param str name: The name of the certificate.
         :return: The deleted CertificateOperation
         :rtype: ~azure.keyvault.certificates.models.CertificateOperation
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         bundle = await self._client.delete_certificate_operation(
             vault_base_url=self.vault_url,
@@ -750,7 +750,7 @@ async def cancel_certificate_operation(self, name: str, **kwargs: "**Any") -> Ce
         :param str name: The name of the certificate.
         :returns: The cancelled certificate operation
         :rtype: ~azure.keyvault.certificates.models.CertificateOperation
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         bundle = await self._client.update_certificate_operation(
             vault_base_url=self.vault_url,
@@ -773,7 +773,7 @@ async def get_pending_certificate_signing_request(
         :type custom_headers: dict[str, str]
         :return: Base64 encoded pending certificate signing request (PKCS-10).
         :rtype: str
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         error_map = kwargs.pop("error_map", None)
         vault_base_url = self.vault_url
@@ -846,7 +846,7 @@ async def merge_certificate(
         :type tags: dict[str, str]
         :return: The merged certificate operation
         :rtype: ~azure.keyvault.certificates.models.CertificateOperation
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         if enabled is not None:
             attributes = self._client.models.CertificateAttributes(
@@ -874,7 +874,7 @@ async def get_issuer(self, name: str, **kwargs: "**Any") -> Issuer:
         :param str name: The name of the issuer.
         :return: The specified certificate issuer.
         :rtype: ~azure.keyvault.certificates.models.Issuer
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -919,7 +919,7 @@ async def create_issuer(
         :param bool enabled: Determines whether the object is enabled.
         :returns: The created Issuer
         :rtype: ~azure.keyvault.certificates.models.Issuer
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -991,7 +991,7 @@ async def update_issuer(
         :param bool enabled: Determines whether the issuer is enabled.
         :return: The updated issuer
         :rtype: ~azure.keyvault.certificates.models.Issuer
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
         """
         if account_id or password:
             issuer_credentials = self._client.models.IssuerCredentials(account_id=account_id, password=password)
@@ -1038,7 +1038,7 @@ async def delete_issuer(self, name: str, **kwargs: "**Any") -> Issuer:
         :param str name: The name of the issuer.
         :return: Issuer
         :rtype: ~azure.keyvault.certificates.models.Issuer
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py
@@ -1065,7 +1065,7 @@ def list_issuers(self, **kwargs: "**Any") -> AsyncIterable[IssuerBase]:
 
         :return: An iterator like instance of Issuers
         :rtype: ~azure.core.paging.ItemPaged[~azure.keyvault.certificates.models.Issuer]
-        :raises: ~azure.core.exceptions.HttpResponseError
+        :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
         Example:
             .. literalinclude:: ../tests/test_examples_certificates_async.py