aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/backends/interfaces.rst4
-rw-r--r--docs/hazmat/primitives/asymmetric/dh.rst3
-rw-r--r--docs/hazmat/primitives/asymmetric/serialization.rst8
-rw-r--r--docs/spelling_wordlist.txt1
4 files changed, 9 insertions, 7 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 8ea1cf99..93eedbe6 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -457,7 +457,7 @@ A specific ``backend`` may provide one or more of these interfaces.
.. versionadded:: 2.0
:param bytes data: PEM data to load.
- :return: A new instance of the appropriate type of encryption
+ :return: A new instance of the appropriate type of asymmetric
parameters the serialized data contains.
:raises ValueError: If the data could not be deserialized.
@@ -490,7 +490,7 @@ A specific ``backend`` may provide one or more of these interfaces.
.. versionadded:: 2.0
:param bytes data: DER data to load.
- :return: A new instance of the appropriate type of encryption
+ :return: A new instance of the appropriate type of asymmetric
parameters the serialized data contains.
:raises ValueError: If the data could not be deserialized.
diff --git a/docs/hazmat/primitives/asymmetric/dh.rst b/docs/hazmat/primitives/asymmetric/dh.rst
index 971d3452..2e894dba 100644
--- a/docs/hazmat/primitives/asymmetric/dh.rst
+++ b/docs/hazmat/primitives/asymmetric/dh.rst
@@ -130,7 +130,8 @@ Group parameters
:class:`~cryptography.hazmat.primitives.serialization.Encoding` enum.
:param format: A value from the
- :class:`~cryptography.hazmat.primitives.serialization.ParameterFormat` enum.
+ :class:`~cryptography.hazmat.primitives.serialization.ParameterFormat`
+ enum. At the moment only ``PKCS3`` is supported.
:return bytes: Serialized parameters.
diff --git a/docs/hazmat/primitives/asymmetric/serialization.rst b/docs/hazmat/primitives/asymmetric/serialization.rst
index b0cfbd0e..24e2b89c 100644
--- a/docs/hazmat/primitives/asymmetric/serialization.rst
+++ b/docs/hazmat/primitives/asymmetric/serialization.rst
@@ -199,8 +199,8 @@ all begin with ``-----BEGIN {format}-----`` and end with ``-----END
.. versionadded:: 2.0
- Deserialize encryption parameters from PEM encoded data to one of the supported
- asymmetric encryption parameters types.
+ Deserialize parameters from PEM encoded data to one of the supported
+ asymmetric parameters types.
.. doctest::
@@ -317,8 +317,8 @@ the rest.
.. versionadded:: 2.0
- Deserialize encryption parameters from DER encoded data to one of the supported
- asymmetric encryption parameters types.
+ Deserialize parameters from DER encoded data to one of the supported
+ asymmetric parameters types.
:param bytes data: The DER encoded parameters data.
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index d9921a0e..3ebc63d1 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -26,6 +26,7 @@ DER
deserialize
deserialized
Deserialization
+deserializing
Diffie
Diffie
disambiguating