Move doc

src/pk_encryption.rs

@@ -1,14 +1,3 @@
-//! ☣️  Compat support for libolm's PkEncryption and PkDecryption
-//!
-//! This implements the `m.megolm_backup.v1.curve25519-aes-sha2` described in
-//! the Matrix [spec]. This is a asymmetric encryption scheme based on
-//! Curve25519.
-//!
-//! **Warning**: Please note the algorithm contains a critical flaw and does not
-//! provide authentication of the ciphertext.
-//!
-//! [spec]: https://spec.matrix.org/v1.11/client-server-api/#backup-algorithm-mmegolm_backupv1curve25519-aes-sha2
-
 use pyo3::{
     pyclass, pymethods,
     types::{PyBytes, PyType},
@@ -33,7 +22,16 @@ pub struct Message {
     ephemeral_key: Vec<u8>,
 }
 
-/// The decryption component of the PkEncryption support.
+/// ☣️  Compat support for libolm's PkDecryption.
+///
+/// This implements the `m.megolm_backup.v1.curve25519-aes-sha2` described in
+/// the Matrix [spec]. This is a asymmetric encryption scheme based on
+/// Curve25519.
+///
+/// **Warning**: Please note the algorithm contains a critical flaw and does not
+/// provide authentication of the ciphertext.
+///
+/// [spec]: https://spec.matrix.org/v1.11/client-server-api/#backup-algorithm-mmegolm_backupv1curve25519-aes-sha2
 #[pyclass]
 pub struct PkDecryption {
     inner: vodozemac::pk_encryption::PkDecryption,
@@ -95,7 +93,16 @@ impl PkDecryption {
     }
 }
 
-/// The encryption component of PkEncryption support.
+/// ☣️  Compat support for libolm's PkEncryption.
+///
+/// This implements the `m.megolm_backup.v1.curve25519-aes-sha2` described in
+/// the Matrix [spec]. This is a asymmetric encryption scheme based on
+/// Curve25519.
+///
+/// **Warning**: Please note the algorithm contains a critical flaw and does not
+/// provide authentication of the ciphertext.
+///
+/// [spec]: https://spec.matrix.org/v1.11/client-server-api/#backup-algorithm-mmegolm_backupv1curve25519-aes-sha2
 #[pyclass]
 pub struct PkEncryption {
     inner: vodozemac::pk_encryption::PkEncryption,