From 41d6bcc2a6ce1438e8068d3b111f27fd0c5199a1 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Fri, 18 Feb 2022 11:33:16 +0100 Subject: [PATCH] Format code in doc comments --- .rustfmt.toml | 1 + crates/ruma-client/src/lib.rs | 7 +++++-- crates/ruma-identifiers/src/device_id.rs | 2 +- crates/ruma-identifiers/src/event_id.rs | 5 +---- crates/ruma-identifiers/src/room_alias_id.rs | 5 +---- crates/ruma-identifiers/src/room_id.rs | 5 +---- .../src/room_or_room_alias_id.rs | 5 +---- crates/ruma-identifiers/src/signatures.rs | 3 ++- crates/ruma-identifiers/src/user_id.rs | 8 +++----- crates/ruma-serde/src/urlencoded/de.rs | 12 +++++++---- crates/ruma-serde/src/urlencoded/ser.rs | 10 +++------- crates/ruma-signatures/src/functions.rs | 20 ++++++++++--------- 12 files changed, 38 insertions(+), 45 deletions(-) diff --git a/.rustfmt.toml b/.rustfmt.toml index d7d9e809..3a24d2aa 100644 --- a/.rustfmt.toml +++ b/.rustfmt.toml @@ -1,4 +1,5 @@ comment_width = 100 +format_code_in_doc_comments = true imports_granularity = "Crate" newline_style = "Unix" use_small_heuristics = "Max" diff --git a/crates/ruma-client/src/lib.rs b/crates/ruma-client/src/lib.rs index 419ac815..5044d529 100644 --- a/crates/ruma-client/src/lib.rs +++ b/crates/ruma-client/src/lib.rs @@ -56,13 +56,16 @@ //! # let client = MatrixClient::new(homeserver_url, None); //! use std::convert::TryFrom; //! +//! use ruma_api::MatrixVersion; //! use ruma_client_api::alias::get_alias; //! use ruma_identifiers::{room_alias_id, room_id}; -//! use ruma_api::MatrixVersion; //! //! async { //! let response = client -//! .send_request(get_alias::v3::Request::new(room_alias_id!("#example_room:example.com")), &[MatrixVersion::V1_0]) +//! .send_request( +//! get_alias::v3::Request::new(room_alias_id!("#example_room:example.com")), +//! &[MatrixVersion::V1_0], +//! ) //! .await?; //! //! assert_eq!(response.room_id, room_id!("!n8f893n9:example.com")); diff --git a/crates/ruma-identifiers/src/device_id.rs b/crates/ruma-identifiers/src/device_id.rs index 5555e106..ad14d4b7 100644 --- a/crates/ruma-identifiers/src/device_id.rs +++ b/crates/ruma-identifiers/src/device_id.rs @@ -9,7 +9,7 @@ use crate::generate_localpart; /// # Example /// /// ``` -/// use ruma_identifiers::{DeviceId, device_id}; +/// use ruma_identifiers::{device_id, DeviceId}; /// /// let random_id = DeviceId::new(); /// assert_eq!(random_id.as_str().len(), 8); diff --git a/crates/ruma-identifiers/src/event_id.rs b/crates/ruma-identifiers/src/event_id.rs index 91e22a57..ddc27545 100644 --- a/crates/ruma-identifiers/src/event_id.rs +++ b/crates/ruma-identifiers/src/event_id.rs @@ -20,10 +20,7 @@ use crate::ServerName; /// # use std::convert::TryFrom; /// # use ruma_identifiers::EventId; /// // Original format -/// assert_eq!( -/// <&EventId>::try_from("$h29iv0s8:example.com").unwrap(), -/// "$h29iv0s8:example.com" -/// ); +/// assert_eq!(<&EventId>::try_from("$h29iv0s8:example.com").unwrap(), "$h29iv0s8:example.com"); /// // Room version 3 format /// assert_eq!( /// <&EventId>::try_from("$acR1l0raoZnm60CBwAVgqbZqoO/mYU81xysh1u7XcJk").unwrap(), diff --git a/crates/ruma-identifiers/src/room_alias_id.rs b/crates/ruma-identifiers/src/room_alias_id.rs index f9d9477d..dece33cc 100644 --- a/crates/ruma-identifiers/src/room_alias_id.rs +++ b/crates/ruma-identifiers/src/room_alias_id.rs @@ -10,10 +10,7 @@ use crate::{server_name::ServerName, EventId, MatrixToRef}; /// ``` /// # use std::convert::TryFrom; /// # use ruma_identifiers::RoomAliasId; -/// assert_eq!( -/// <&RoomAliasId>::try_from("#ruma:example.com").unwrap(), -/// "#ruma:example.com" -/// ); +/// assert_eq!(<&RoomAliasId>::try_from("#ruma:example.com").unwrap(), "#ruma:example.com"); /// ``` #[repr(transparent)] #[derive(PartialEq, Eq, PartialOrd, Ord, Hash)] diff --git a/crates/ruma-identifiers/src/room_id.rs b/crates/ruma-identifiers/src/room_id.rs index 427b7995..e0bc13cc 100644 --- a/crates/ruma-identifiers/src/room_id.rs +++ b/crates/ruma-identifiers/src/room_id.rs @@ -10,10 +10,7 @@ use crate::{EventId, MatrixToRef, ServerName}; /// ``` /// # use std::convert::TryFrom; /// # use ruma_identifiers::RoomId; -/// assert_eq!( -/// <&RoomId>::try_from("!n8f893n9:example.com").unwrap(), -/// "!n8f893n9:example.com" -/// ); +/// assert_eq!(<&RoomId>::try_from("!n8f893n9:example.com").unwrap(), "!n8f893n9:example.com"); /// ``` #[repr(transparent)] #[derive(PartialEq, Eq, PartialOrd, Ord, Hash)] diff --git a/crates/ruma-identifiers/src/room_or_room_alias_id.rs b/crates/ruma-identifiers/src/room_or_room_alias_id.rs index 34148444..7144467c 100644 --- a/crates/ruma-identifiers/src/room_or_room_alias_id.rs +++ b/crates/ruma-identifiers/src/room_or_room_alias_id.rs @@ -13,10 +13,7 @@ use crate::{server_name::ServerName, RoomAliasId, RoomId}; /// ``` /// # use std::convert::TryFrom; /// # use ruma_identifiers::RoomOrAliasId; -/// assert_eq!( -/// <&RoomOrAliasId>::try_from("#ruma:example.com").unwrap(), -/// "#ruma:example.com" -/// ); +/// assert_eq!(<&RoomOrAliasId>::try_from("#ruma:example.com").unwrap(), "#ruma:example.com"); /// /// assert_eq!( /// <&RoomOrAliasId>::try_from("!n8f893n9:example.com").unwrap(), diff --git a/crates/ruma-identifiers/src/signatures.rs b/crates/ruma-identifiers/src/signatures.rs index b88f7dc3..c60e56e3 100644 --- a/crates/ruma-identifiers/src/signatures.rs +++ b/crates/ruma-identifiers/src/signatures.rs @@ -12,7 +12,8 @@ pub type EntitySignatures = BTreeMap>, String>; /// let key_identifier = KeyId::from_parts(SigningKeyAlgorithm::Ed25519, "1"); /// let mut signatures = Signatures::new(); /// let server_name = server_name!("example.org"); -/// let signature = "YbJva03ihSj5mPk+CHMJKUKlCXCPFXjXOK6VqBnN9nA2evksQcTGn6hwQfrgRHIDDXO2le49x7jnWJHMJrJoBQ"; +/// let signature = +/// "YbJva03ihSj5mPk+CHMJKUKlCXCPFXjXOK6VqBnN9nA2evksQcTGn6hwQfrgRHIDDXO2le49x7jnWJHMJrJoBQ"; /// signatures.insert(server_name, key_identifier, signature.into()); /// ``` #[derive(Clone, Debug, Default)] diff --git a/crates/ruma-identifiers/src/user_id.rs b/crates/ruma-identifiers/src/user_id.rs index 5c422e73..a40d1d28 100644 --- a/crates/ruma-identifiers/src/user_id.rs +++ b/crates/ruma-identifiers/src/user_id.rs @@ -12,10 +12,7 @@ use crate::{MatrixToRef, ServerName}; /// ``` /// # use std::convert::TryFrom; /// # use ruma_identifiers::UserId; -/// assert_eq!( -/// <&UserId>::try_from("@carl:example.com").unwrap(), -/// "@carl:example.com" -/// ); +/// assert_eq!(<&UserId>::try_from("@carl:example.com").unwrap(), "@carl:example.com"); /// ``` #[repr(transparent)] #[derive(PartialEq, Eq, PartialOrd, Ord, Hash)] @@ -115,7 +112,8 @@ impl UserId { /// /// let message = format!( /// r#"Thanks for the update {display_name}."#, - /// link = user_id!("@jplatte:notareal.hs").matrix_to_url(), display_name = "jplatte", + /// link = user_id!("@jplatte:notareal.hs").matrix_to_url(), + /// display_name = "jplatte", /// ); /// ``` pub fn matrix_to_url(&self) -> MatrixToRef<'_> { diff --git a/crates/ruma-serde/src/urlencoded/de.rs b/crates/ruma-serde/src/urlencoded/de.rs index 9cab35ae..6c151bba 100644 --- a/crates/ruma-serde/src/urlencoded/de.rs +++ b/crates/ruma-serde/src/urlencoded/de.rs @@ -31,8 +31,10 @@ use val_or_vec::ValOrVec; /// /// assert_eq!( /// ruma_serde::urlencoded::from_bytes::>( -/// b"bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter"), -/// Ok(meal)); +/// b"bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter" +/// ), +/// Ok(meal) +/// ); /// ``` pub fn from_bytes<'de, T>(input: &'de [u8]) -> Result where @@ -53,8 +55,10 @@ where /// /// assert_eq!( /// ruma_serde::urlencoded::from_str::>( -/// "bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter"), -/// Ok(meal)); +/// "bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter" +/// ), +/// Ok(meal) +/// ); /// ``` pub fn from_str<'de, T>(input: &'de str) -> Result where diff --git a/crates/ruma-serde/src/urlencoded/ser.rs b/crates/ruma-serde/src/urlencoded/ser.rs index a1791235..699b637a 100644 --- a/crates/ruma-serde/src/urlencoded/ser.rs +++ b/crates/ruma-serde/src/urlencoded/ser.rs @@ -13,16 +13,12 @@ use serde::ser; /// Serializes a value into a `application/x-www-form-urlencoded` `String` buffer. /// /// ``` -/// let meal = &[ -/// ("bread", "baguette"), -/// ("cheese", "comté"), -/// ("meat", "ham"), -/// ("fat", "butter"), -/// ]; +/// let meal = &[("bread", "baguette"), ("cheese", "comté"), ("meat", "ham"), ("fat", "butter")]; /// /// assert_eq!( /// ruma_serde::urlencoded::to_string(meal), -/// Ok("bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter".to_owned())); +/// Ok("bread=baguette&cheese=comt%C3%A9&meat=ham&fat=butter".to_owned()) +/// ); /// ``` pub fn to_string(input: T) -> Result { let mut urlencoder = UrlEncodedSerializer::new("".to_owned()); diff --git a/crates/ruma-signatures/src/functions.rs b/crates/ruma-signatures/src/functions.rs index ff19c4c1..33d881ed 100644 --- a/crates/ruma-signatures/src/functions.rs +++ b/crates/ruma-signatures/src/functions.rs @@ -116,7 +116,8 @@ static REFERENCE_HASH_FIELDS_TO_REMOVE: &[&str] = &["age_ts", "signatures", "uns /// let key_pair = ruma_signatures::Ed25519KeyPair::from_der( /// &document, /// "1".into(), // The "version" of the key. -/// ).unwrap(); +/// ) +/// .unwrap(); /// /// // Deserialize some JSON. /// let mut value = serde_json::from_str("{}").unwrap(); @@ -191,11 +192,10 @@ where /// # Examples /// /// ```rust -/// let input = -/// r#"{ -/// "本": 2, -/// "日": 1 -/// }"#; +/// let input = r#"{ +/// "本": 2, +/// "日": 1 +/// }"#; /// /// let object = serde_json::from_str(input).unwrap(); /// let canonical = ruma_signatures::canonical_json(&object).unwrap(); @@ -430,7 +430,8 @@ pub fn reference_hash( /// let key_pair = Ed25519KeyPair::from_der( /// &document, /// "1".into(), // The "version" of the key. -/// ).unwrap(); +/// ) +/// .unwrap(); /// /// // Deserialize an event from JSON. /// let mut object = serde_json::from_str( @@ -449,8 +450,9 @@ pub fn reference_hash( /// "unsigned": { /// "age_ts": 1000000 /// } -/// }"# -/// ).unwrap(); +/// }"#, +/// ) +/// .unwrap(); /// /// // Hash and sign the JSON with the key pair. /// assert!(hash_and_sign_event("domain", &key_pair, &mut object, &RoomVersionId::V1).is_ok());