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

doc: Add doc link to as_str implementations

Browse Source
This commit is contained in:
Kévin Commaille 2022-05-30 15:17:40 +02:00 committed by Kévin Commaille
parent 4d89c7cc08
commit 7f164b3173
4 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
crates/ruma-client-api/src/doc/string_enum.md
View File

@ -1,4 +1,5 @@
<!-- Keep this comment so the content is always included as a new paragraph --> <!-- Keep this comment so the content is always included as a new paragraph -->
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 formats that are not available as a string with `::from()` / `.into()`. To check for formats 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()`](Self::as_str()).

3
crates/ruma-common/src/doc/string_enum.md
View File

@ -1,4 +1,5 @@
<!-- Keep this comment so the content is always included as a new paragraph --> <!-- Keep this comment so the content is always included as a new paragraph -->
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 formats that are not available as a string with `::from()` / `.into()`. To check for formats 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()`](Self::as_str()).

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

@ -82,7 +82,8 @@ pub mod v1 {
/// ///
/// 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 formats that are not available as a /// string with `::from() / .into()`. To check for formats 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()`](Self::as_str()).
#[derive(Clone, Debug, PartialEq, Eq, StringEnum)] #[derive(Clone, Debug, PartialEq, Eq, StringEnum)]
#[non_exhaustive] #[non_exhaustive]
pub enum ProfileField { pub enum ProfileField {

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

@ -12,7 +12,7 @@ pub mod lookup_3pid;
/// ///
/// 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 formats that are not available as a documented /// string with `::from() / .into()`. To check for formats that are not available as a documented
/// variant here, use its string representation, obtained through `.as_str()`. /// variant here, use its string representation, obtained through [`.as_str()`](Self::as_str()).
#[derive(Debug, PartialEq, Eq, Clone, StringEnum)] #[derive(Debug, PartialEq, Eq, Clone, StringEnum)]
#[non_exhaustive] #[non_exhaustive]
#[ruma_enum(rename_all = "snake_case")] #[ruma_enum(rename_all = "snake_case")]