chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up code blocks in doc strings

Browse Source
This commit is contained in:
Jonas Platte 2023-02-01 16:58:47 +01:00
parent 457b5187a7
commit 19006cd047
No known key found for this signature in database
GPG Key ID: AAA7A61F696C3E0C
5 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/ruma-federation-api/src/query/get_profile_information.rs
View File

@ -83,7 +83,7 @@ pub mod v1 {
/// Profile fields to specify in query. /// Profile fields to specify in query.
/// ///
/// This type can hold an arbitrary string. To build this with a custom value, convert it from a /// This type can hold an arbitrary string. To build this with a custom value, convert it from a
/// string with `::from() / .into()`. To check for values that are not available as a /// string with `::from()` / `.into()`. To check for values that are not available as a
/// documented variant here, use its string representation, obtained through /// documented variant here, use its string representation, obtained through
/// [`.as_str()`](Self::as_str()). /// [`.as_str()`](Self::as_str()).
#[derive(Clone, PartialEq, Eq, StringEnum)] #[derive(Clone, PartialEq, Eq, StringEnum)]

2
crates/ruma-identity-service-api/src/lookup.rs
View File

@ -11,7 +11,7 @@ pub mod lookup_3pid;
/// Matrix Spec. /// Matrix Spec.
/// ///
/// This type can hold an arbitrary string. To build this with a custom value, convert it from a /// This type can hold an arbitrary string. To build this with a custom value, convert it from a
/// string with `::from() / .into()`. To check for values that are not available as a documented /// string with `::from()` / `.into()`. To check for values that are not available as a documented
/// variant here, use its string representation, obtained through [`.as_str()`](Self::as_str()). /// variant here, use its string representation, obtained through [`.as_str()`](Self::as_str()).
#[derive(Clone, PartialEq, Eq, StringEnum)] #[derive(Clone, PartialEq, Eq, StringEnum)]
#[non_exhaustive] #[non_exhaustive]

2
crates/ruma-macros/src/events/event_content.rs
View File

@ -638,7 +638,7 @@ fn generate_event_content_without_relation<'a>(
let type_doc = format!( let type_doc = format!(
"Form of [`{ident}`] without relation.\n\n\ "Form of [`{ident}`] without relation.\n\n\
To construct this type, construct a [`{ident}`] and then use one of its `::from() / .into()` methods." To construct this type, construct a [`{ident}`] and then use one of its `::from()` / `.into()` methods."
); );
let without_relation_ident = format_ident!("{ident}WithoutRelation"); let without_relation_ident = format_ident!("{ident}WithoutRelation");

2
crates/ruma-macros/src/events/event_type.rs
View File

@ -192,7 +192,7 @@ fn generate_enum(
#[doc = #enum_doc] #[doc = #enum_doc]
/// ///
/// This type can hold an arbitrary string. To build events with a custom type, convert it /// This type can hold an arbitrary string. To build events with a custom type, convert it
/// from a string with `::from() / .into()`. To check for events that are not available as a /// from a string with `::from()` / `.into()`. To check for events that are not available as a
/// documented variant here, use its string representation, obtained through `.to_string()`. /// documented variant here, use its string representation, obtained through `.to_string()`.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)] #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]

2
crates/ruma-push-gateway-api/src/send_event_notification.rs
View File

@ -147,7 +147,7 @@ pub mod v1 {
/// notifications in a way that will preserve battery power on mobile devices. /// notifications in a way that will preserve battery power on mobile devices.
/// ///
/// This type can hold an arbitrary string. To build this with a custom value, convert it from a /// This type can hold an arbitrary string. To build this with a custom value, convert it from a
/// string with `::from() / .into()`. To check for values that are not available as a /// string with `::from()` / `.into()`. To check for values that are not available as a
/// documented variant here, use its string representation, obtained through `.as_str()`. /// documented variant here, use its string representation, obtained through `.as_str()`.
#[derive(Clone, Default, PartialEq, Eq, StringEnum)] #[derive(Clone, Default, PartialEq, Eq, StringEnum)]
#[ruma_enum(rename_all = "snake_case")] #[ruma_enum(rename_all = "snake_case")]