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

doc: migrate links from matrix-doc to matrix-spec(-proposals)

Browse Source
This commit is contained in:
homersimpsons 2022-03-08 10:24:26 +01:00 committed by GitHub
parent fca0f6a22b
commit 2ec50bd03c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/ruma-appservice-api/src/event/push_events.rs
View File

@ -64,7 +64,7 @@ pub mod v1 {
/// [MSC2409] regarding supporting EDUs in the future, though it seems to be planned to put
/// EDUs into a different JSON key than `events` to stay backwards compatible.
///
/// [MSC2409]: https://github.com/matrix-org/matrix-doc/pull/2409
/// [MSC2409]: https://github.com/matrix-org/matrix-spec-proposals/pull/2409
#[cfg(feature = "helper")]
pub fn try_into_sync_response(
self,

2
crates/ruma-appservice-api/src/thirdparty/get_location_for_protocol.rs vendored
View File

@ -29,7 +29,7 @@ pub mod v1 {
pub protocol: &'a str,
/// One or more custom fields to help identify the third party location.
// The specification is incorrect for this parameter. See matrix-org/matrix-doc#2352.
// The specification is incorrect for this parameter. See [matrix-spec#560](https://github.com/matrix-org/matrix-spec/issues/560).
#[ruma_api(query_map)]
pub fields: BTreeMap<String, String>,
}

2
crates/ruma-appservice-api/src/thirdparty/get_user_for_protocol.rs vendored
View File

@ -29,7 +29,7 @@ pub mod v1 {
pub protocol: &'a str,
/// One or more custom fields that are passed to the AS to help identify the user.
// The specification is incorrect for this parameter. See matrix-org/matrix-doc#2352.
// The specification is incorrect for this parameter. See [matrix-spec#560](https://github.com/matrix-org/matrix-spec/issues/560).
#[ruma_api(query_map)]
pub fields: BTreeMap<String, String>,
}

4
crates/ruma-client-api/src/media/create_content.rs
View File

@ -37,7 +37,7 @@ pub mod v3 {
/// Should the server return a blurhash or not.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[ruma_api(query)]
#[cfg(feature = "unstable-msc2448")]
#[serde(default, skip_serializing_if = "ruma_serde::is_default", rename = "xyz.amorgan.blurhash")]
@ -51,7 +51,7 @@ pub mod v3 {
/// The [BlurHash](https://blurha.sh) for the uploaded content.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-client-api/src/media/get_content_as_filename.rs
View File

@ -48,7 +48,7 @@ pub mod v3 {
/// The content type of the file that was previously uploaded.
#[ruma_api(header = CONTENT_TYPE)]
// Potentially not actually optional – https://github.com/matrix-org/matrix-doc/pull/2818
// Potentially not actually optional – https://github.com/matrix-org/matrix-spec-proposals/pull/2818
pub content_type: Option<String>,
/// The value of the `Content-Disposition` HTTP header, possibly containing the name of the

2
crates/ruma-client-api/src/profile/get_avatar_url.rs
View File

@ -42,7 +42,7 @@ pub mod v3 {
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-client-api/src/profile/get_profile.rs
View File

@ -46,7 +46,7 @@ pub mod v3 {
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-client-api/src/profile/set_avatar_url.rs
View File

@ -48,7 +48,7 @@ pub mod v3 {
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<&'a str>,

6
crates/ruma-client-api/src/session/get_login_types.rs
View File

@ -190,12 +190,12 @@ pub mod v3 {
/// An SSO login identity provider brand identifier.
///
/// The predefined ones can be found in the matrix-doc repo in a [separate
/// document][matrix-doc]. To use a custom brand string, simply use
/// The predefined ones can be found in the matrix-spec-proposals repo in a [separate
/// document][matrix-spec-proposals]. To use a custom brand string, simply use
/// `IdentityProviderBrand::from("custom-brand")` or `"custom-brand".into()` (if the type is
/// known from the surrounding context).
///
/// [matrix-doc]: https://github.com/matrix-org/matrix-doc/blob/v1.1/informal/idp-brands.md
/// [matrix-spec-proposals]: https://github.com/matrix-org/matrix-spec-proposals/blob/v1.1/informal/idp-brands.md
#[derive(Clone, Debug, PartialEq, Eq, StringEnum)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub enum IdentityProviderBrand {

2
crates/ruma-client-api/src/thirdparty/get_location_for_protocol.rs vendored
View File

@ -27,7 +27,7 @@ pub mod v3 {
pub protocol: &'a str,
/// One or more custom fields to help identify the third party location.
// The specification is incorrect for this parameter. See matrix-org/matrix-doc#2352.
// The specification is incorrect for this parameter. See [matrix-spec#560](https://github.com/matrix-org/matrix-spec/issues/560).
#[ruma_api(query_map)]
pub fields: BTreeMap<String, String>,
}

2
crates/ruma-client-api/src/thirdparty/get_user_for_protocol.rs vendored
View File

@ -27,7 +27,7 @@ pub mod v3 {
pub protocol: &'a str,
/// One or more custom fields that are passed to the AS to help identify the user.
// The specification is incorrect for this parameter. See matrix-org/matrix-doc#2352.
// The specification is incorrect for this parameter. See [matrix-spec#560](https://github.com/matrix-org/matrix-spec/issues/560).
#[ruma_api(query_map)]
pub fields: BTreeMap<String, String>,
}

6
crates/ruma-common/src/events/key/verification.rs
View File

@ -2,10 +2,10 @@
//!
//! This module also contains types shared by events in its child namespaces.
//!
//! The MSC for the in-room variants of the `m.key.verification.*` events can be found
//! [on GitHub][github-matrix-doc-2214].
//! The MSC for the in-room variants of the `m.key.verification.*` events can be found on
//! [MSC2241].
//!
//! [github-matrix-doc-2214]: https://github.com/matrix-org/matrix-doc/pull/2241
//! [MSC2241]: https://github.com/matrix-org/matrix-spec-proposals/pull/2241
use ruma_identifiers::EventId;
use ruma_serde::StringEnum;

2
crates/ruma-common/src/events/room.rs
View File

@ -68,7 +68,7 @@ pub struct ImageInfo {
/// The [BlurHash](https://blurha.sh) for this image.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

10
crates/ruma-common/src/events/room/avatar.rs
View File

@ -26,14 +26,14 @@ pub struct RoomAvatarEventContent {
/// URL of the avatar image.
///
/// With the `unstable-pre-spec` feature, this field is optional.
/// See [matrix-doc#2006](https://github.com/matrix-org/matrix-doc/issues/2006).
/// See [matrix-spec#471](https://github.com/matrix-org/matrix-spec/issues/471).
#[cfg(not(feature = "unstable-pre-spec"))]
pub url: Box<MxcUri>,
/// URL of the avatar image.
///
/// Without the `unstable-pre-spec` feature, this field is not optional.
/// See [matrix-doc#2006](https://github.com/matrix-org/matrix-doc/issues/2006).
/// See [matrix-spec#471](https://github.com/matrix-org/matrix-spec/issues/471).
#[cfg(feature = "unstable-pre-spec")]
pub url: Option<Box<MxcUri>>,
}
@ -42,7 +42,7 @@ impl RoomAvatarEventContent {
/// Create an `RoomAvatarEventContent` from the given image URL.
///
/// With the `unstable-pre-spec` feature, this method takes no parameters.
/// See [matrix-doc#2006](https://github.com/matrix-org/matrix-doc/issues/2006).
/// See [matrix-spec#471](https://github.com/matrix-org/matrix-spec/issues/471).
#[cfg(not(feature = "unstable-pre-spec"))]
pub fn new(url: Box<MxcUri>) -> Self {
Self { info: None, url }
@ -51,7 +51,7 @@ impl RoomAvatarEventContent {
/// Create an empty `RoomAvatarEventContent`.
///
/// Without the `unstable-pre-spec` feature, this method takes an `MxcUri`.
/// See [matrix-doc#2006](https://github.com/matrix-org/matrix-doc/issues/2006).
/// See [matrix-spec#471](https://github.com/matrix-org/matrix-spec/issues/471).
#[cfg(feature = "unstable-pre-spec")]
pub fn new() -> Self {
Self::default()
@ -89,7 +89,7 @@ pub struct ImageInfo {
/// The [BlurHash](https://blurha.sh) for this image.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-common/src/events/room/member.rs
View File

@ -82,7 +82,7 @@ pub struct RoomMemberEventContent {
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-common/src/events/room/message.rs
View File

@ -941,7 +941,7 @@ pub struct VideoInfo {
/// The [BlurHash](https://blurha.sh) for this video.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-common/src/push.rs
View File

@ -406,7 +406,7 @@ pub struct PusherData {
/// For more information, see [Sygnal docs][sygnal].
///
/// [sygnal]: https://github.com/matrix-org/sygnal/blob/main/docs/applications.md#ios-applications-beware
// Not specified, issue: https://github.com/matrix-org/matrix-doc/issues/3474
// Not specified, issue: https://github.com/matrix-org/matrix-spec/issues/921
#[cfg(feature = "unstable-pre-spec")]
#[serde(default, skip_serializing_if = "JsonValue::is_null")]
pub default_payload: JsonValue,

4
crates/ruma-common/src/thirdparty.rs
View File

@ -89,7 +89,7 @@ pub struct ProtocolInstance {
/// A unique identifier across all instances.
///
/// See [matrix-doc#3203](https://github.com/matrix-org/matrix-doc/issues/3203).
/// See [matrix-spec#833](https://github.com/matrix-org/matrix-spec/issues/833).
#[cfg(feature = "unstable-pre-spec")]
pub instance_id: String,
}
@ -112,7 +112,7 @@ pub struct ProtocolInstanceInit {
/// A unique identifier across all instances.
///
/// See [matrix-doc#3203](https://github.com/matrix-org/matrix-doc/issues/3203).
/// See [matrix-spec#833](https://github.com/matrix-org/matrix-spec/issues/833).
#[cfg(feature = "unstable-pre-spec")]
pub instance_id: String,
}

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

@ -46,7 +46,7 @@ impl OldVerifyKey {
}
}
// Spec is wrong, all fields are required (see https://github.com/matrix-org/matrix-doc/issues/2508)
// Spec is wrong, all fields are required (see https://github.com/matrix-org/matrix-spec/issues/613)
/// Queried server key, signed by the notary server.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]

4
crates/ruma-federation-api/src/membership/create_join_event.rs
View File

@ -36,7 +36,7 @@ impl RoomState {
/// Creates an empty `RoomState` with the given `origin`.
///
/// With the `unstable-pre-spec` feature, this method doesn't take any parameters.
/// See [matrix-doc#1664](https://github.com/matrix-org/matrix-doc/issues/1664).
/// See [matrix-spec#374](https://github.com/matrix-org/matrix-spec/issues/374).
pub fn new(origin: String) -> Self {
Self { origin, auth_chain: Vec::new(), state: Vec::new() }
}
@ -45,7 +45,7 @@ impl RoomState {
/// Creates an empty `RoomState` with the given `origin`.
///
/// Without the `unstable-pre-spec` feature, this method takes a parameter for the origin
/// server. See [matrix-doc#1664](https://github.com/matrix-org/matrix-doc/issues/1664).
/// See [matrix-spec#374](https://github.com/matrix-org/matrix-spec/issues/374).
pub fn new() -> Self {
Self { auth_chain: Vec::new(), state: Vec::new() }
}

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

@ -55,7 +55,7 @@ pub mod v1 {
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,

2
crates/ruma-federation-api/src/serde/v1_pdu.rs
View File

@ -6,7 +6,7 @@
//!
//! For more information, see this [GitHub issue][issue].
//!
//! [issue]: https://github.com/matrix-org/matrix-doc/issues/2541
//! [issue]: https://github.com/matrix-org/matrix-spec-proposals/issues/2541
use std::{fmt, marker::PhantomData};

4
crates/ruma-federation-api/src/transactions/send_transaction_message.rs
View File

@ -44,7 +44,7 @@ pub mod v1 {
/// Must not be more than 50 items.
///
/// With the `unstable-pre-spec` feature, sending `pdus` is optional.
/// See [matrix-doc#2824](https://github.com/matrix-org/matrix-doc/issues/2824).
/// See [matrix-spec#705](https://github.com/matrix-org/matrix-spec/issues/705).
#[cfg_attr(feature = "unstable-pre-spec", serde(default, skip_serializing_if = "<[_]>::is_empty"))]
pub pdus: &'a [Box<RawJsonValue>],
@ -60,7 +60,7 @@ pub mod v1 {
/// Map of event IDs and response for each PDU given in the request.
///
/// With the `unstable-msc3618` feature, returning `pdus` is optional.
/// See [MSC3618](https://github.com/matrix-org/matrix-doc/pull/3618).
/// See [MSC3618](https://github.com/matrix-org/matrix-spec-proposals/pull/3618).
#[cfg_attr(feature = "unstable-msc3618", serde(default))]
#[serde(with = "crate::serde::pdu_process_response")]
pub pdus: BTreeMap<Box<EventId>, Result<(), String>>,

2
crates/ruma-identifiers-validation/src/user_id.rs
View File

@ -16,7 +16,7 @@ pub fn validate(s: &str) -> Result<(), Error> {
/// With the `compat` feature enabled, this will also return `Ok(false)` for invalid user ID
/// localparts. User IDs that don't even meet the historical user ID restrictions exist in the wild
/// due to Synapse allowing them over federation. This will likely be fixed in an upcoming room
/// version; see <https://github.com/matrix-org/matrix-doc/pull/2828>.
/// version; see [MSC2828](https://github.com/matrix-org/matrix-spec-proposals/pull/2828).
pub fn localpart_is_fully_conforming(localpart: &str) -> Result<bool, Error> {
// See https://spec.matrix.org/v1.2/appendices/#user-identifiers
let is_fully_conforming = localpart

2
crates/ruma-serde/src/base64.rs
View File

@ -36,7 +36,7 @@ pub struct Conf(base64::Config);
pub struct Standard;
impl Base64Config for Standard {
// See https://github.com/matrix-org/matrix-doc/issues/3211
// See https://github.com/matrix-org/matrix-spec/issues/838
const CONF: Conf = Conf(base64::STANDARD_NO_PAD.decode_allow_trailing_bits(true));
}

2
crates/ruma-state-res/src/room_version.rs
View File

@ -64,7 +64,7 @@ pub struct RoomVersion {
pub allow_knocking: bool,
/// Adds support for the restricted join rule.
///
/// See: <https://github.com/matrix-org/matrix-doc/pull/3289> for more information.
/// See: [MSC3289](https://github.com/matrix-org/matrix-spec-proposals/pull/3289) for more information.
pub restricted_join_rules: bool,
}