From 6fe2fa8fd138d2329b128e7ec75050d5c3bbfacf Mon Sep 17 00:00:00 2001 From: danielsanchezq Date: Mon, 31 Oct 2022 09:57:21 +0100 Subject: [PATCH] Fix docs links --- waku/src/decrypt.rs | 2 +- waku/src/general/mod.rs | 6 +++--- waku/src/node/peers.rs | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/waku/src/decrypt.rs b/waku/src/decrypt.rs index acf443c..466cc85 100644 --- a/waku/src/decrypt.rs +++ b/waku/src/decrypt.rs @@ -38,7 +38,7 @@ pub fn waku_decode_symmetric( /// Decrypt a message using a symmetric key /// -/// As per the [specification](extern char* waku_decode_asymmetric(char* messageJson, char* privateKey)) +/// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_asymmetricchar-messagejson-char-privatekey) pub fn waku_decode_asymmetric( message: &WakuMessage, asymmetric_key: &SecretKey, diff --git a/waku/src/general/mod.rs b/waku/src/general/mod.rs index a152520..88cd56c 100644 --- a/waku/src/general/mod.rs +++ b/waku/src/general/mod.rs @@ -58,9 +58,9 @@ pub(crate) enum JsonResponse { } /// Waku response, just a `Result` with an `String` error. -/// Convenient we can transform a [`JsonResponse`] into a [`std::result::Result`] pub type Result = std::result::Result; +/// Convenient we can transform a [`JsonResponse`] into a [`std::result::Result`] impl From> for Result { fn from(response: JsonResponse) -> Self { match response { @@ -127,14 +127,14 @@ impl WakuMessage { /// Try decode the message with an expected symmetric key /// - /// wrapper around [`crate::decrypt::waku_decode_symmetric`] + /// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_symmetricchar-messagejson-char-symmetrickey) pub fn try_decode_symmetric(&self, symmetric_key: &Key) -> Result { waku_decode_symmetric(self, symmetric_key) } /// Try decode the message with an expected asymmetric key /// - /// wrapper around [`crate::decrypt::waku_decode_asymmetric`] + /// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_asymmetricchar-messagejson-char-privatekey) pub fn try_decode_asymmetric(&self, asymmetric_key: &SecretKey) -> Result { waku_decode_asymmetric(self, asymmetric_key) } diff --git a/waku/src/node/peers.rs b/waku/src/node/peers.rs index dcd7abb..2879cc8 100644 --- a/waku/src/node/peers.rs +++ b/waku/src/node/peers.rs @@ -158,7 +158,7 @@ impl WakuPeerData { } } -/// List of [`WakuPeerData`], return value from [`waku_peers`] funtion +/// List of [`WakuPeerData`] pub type WakuPeers = Vec; /// Retrieve the list of peers known by the Waku node