From b538234bce826f78625ec966ec71a18df3fe29ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Wed, 12 Oct 2022 10:08:58 +0200 Subject: [PATCH] chore: Fix new docs warnings --- crates/ruma-common/src/events/pdu.rs | 2 +- crates/ruma-common/src/serde/duration/opt_ms.rs | 4 ++-- crates/ruma-signatures/src/keys.rs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/ruma-common/src/events/pdu.rs b/crates/ruma-common/src/events/pdu.rs index a4eac001..5c3bc2f7 100644 --- a/crates/ruma-common/src/events/pdu.rs +++ b/crates/ruma-common/src/events/pdu.rs @@ -2,7 +2,7 @@ //! //! The differences between the `RoomV1Pdu` schema and the `RoomV3Pdu` schema are that the //! `RoomV1Pdu` takes an `event_id` field (`RoomV3Pdu` does not), and `auth_events` and -//! `prev_events` take `Vec<(OwnedEventId, EventHash)> rather than `Vec` in +//! `prev_events` take `Vec<(OwnedEventId, EventHash)>` rather than `Vec` in //! `RoomV3Pdu`. use std::collections::BTreeMap; diff --git a/crates/ruma-common/src/serde/duration/opt_ms.rs b/crates/ruma-common/src/serde/duration/opt_ms.rs index 3539aeba..03f88621 100644 --- a/crates/ruma-common/src/serde/duration/opt_ms.rs +++ b/crates/ruma-common/src/serde/duration/opt_ms.rs @@ -11,7 +11,7 @@ use serde::{ ser::{Error, Serialize, Serializer}, }; -/// Serialize an Option. +/// Serialize an `Option`. /// /// Will fail if integer is greater than the maximum integer that can be /// unambiguously represented by an f64. @@ -28,7 +28,7 @@ where } } -/// Deserializes an Option. +/// Deserializes an `Option`. /// /// Will fail if integer is greater than the maximum integer that can be /// unambiguously represented by an f64. diff --git a/crates/ruma-signatures/src/keys.rs b/crates/ruma-signatures/src/keys.rs index 0bb7258f..f44f560d 100644 --- a/crates/ruma-signatures/src/keys.rs +++ b/crates/ruma-signatures/src/keys.rs @@ -144,7 +144,7 @@ impl Ed25519KeyPair { /// /// # Returns /// - /// Returns a Vec representing a DER-encoded PKCS#8 v2 document (with public key) + /// Returns a `Vec` representing a DER-encoded PKCS#8 v2 document (with public key) /// /// # Errors ///