From 4efca6fba5948f4740da3a90afb0ce5c14572ae4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Thu, 30 Nov 2023 14:20:47 +0100 Subject: [PATCH] docs: Point links to v1.9 of the spec --- crates/ruma-client-api/CHANGELOG.md | 4 ++++ crates/ruma-client-api/src/membership/invite_user.rs | 4 ++-- crates/ruma-common/CHANGELOG.md | 1 + crates/ruma-common/src/push/condition.rs | 4 ++-- crates/ruma-identifiers-validation/CHANGELOG.md | 4 ++++ crates/ruma-identifiers-validation/src/error.rs | 2 +- crates/ruma-identifiers-validation/src/mxc_uri.rs | 2 +- xtask/src/ci/spec_links.rs | 2 +- 8 files changed, 16 insertions(+), 7 deletions(-) diff --git a/crates/ruma-client-api/CHANGELOG.md b/crates/ruma-client-api/CHANGELOG.md index d04b9e23..3a926d75 100644 --- a/crates/ruma-client-api/CHANGELOG.md +++ b/crates/ruma-client-api/CHANGELOG.md @@ -6,6 +6,10 @@ Breaking changes: the `conditions` field is optional. - `MissingConditionsError` was removed. +Improvements: + +- Point links to the Matrix 1.9 specification + # 0.17.4 Improvements: diff --git a/crates/ruma-client-api/src/membership/invite_user.rs b/crates/ruma-client-api/src/membership/invite_user.rs index 2952aed1..e25fa935 100644 --- a/crates/ruma-client-api/src/membership/invite_user.rs +++ b/crates/ruma-client-api/src/membership/invite_user.rs @@ -9,8 +9,8 @@ pub mod v3 { //! [by their Matrix identifier][spec-mxid], and one to invite a user //! [by their third party identifier][spec-3pid]. //! - //! [spec-mxid]: https://spec.matrix.org/v1.8/client-server-api/#post_matrixclientv3roomsroomidinvite - //! [spec-3pid]: https://spec.matrix.org/v1.8/client-server-api/#post_matrixclientv3roomsroomidinvite-1 + //! [spec-mxid]: https://spec.matrix.org/v1.9/client-server-api/#post_matrixclientv3roomsroomidinvite + //! [spec-3pid]: https://spec.matrix.org/v1.9/client-server-api/#post_matrixclientv3roomsroomidinvite-1 use ruma_common::{ api::{request, response, Metadata}, diff --git a/crates/ruma-common/CHANGELOG.md b/crates/ruma-common/CHANGELOG.md index 19638a1c..94fb7777 100644 --- a/crates/ruma-common/CHANGELOG.md +++ b/crates/ruma-common/CHANGELOG.md @@ -4,6 +4,7 @@ Improvements: - Stabilize support for `.m.rule.suppress_edits` push rule (MSC3958 / Matrix 1.9) - Add `MatrixVersion::V1_9` +- Point links to the Matrix 1.9 specification # 0.12.1 diff --git a/crates/ruma-common/src/push/condition.rs b/crates/ruma-common/src/push/condition.rs index a7dad9d1..bda7930d 100644 --- a/crates/ruma-common/src/push/condition.rs +++ b/crates/ruma-common/src/push/condition.rs @@ -586,7 +586,7 @@ mod tests { assert!(!"m".matches_word("[[:alpha:]]?")); assert!("[[:alpha:]]!".matches_word("[[:alpha:]]?")); - // From the spec: + // From the spec: assert!("An example event.".matches_word("ex*ple")); assert!("exple".matches_word("ex*ple")); assert!("An exciting triple-whammy".matches_word("ex*ple")); @@ -635,7 +635,7 @@ mod tests { assert!("".matches_pattern("*", false)); assert!(!"foo".matches_pattern("", false)); - // From the spec: + // From the spec: assert!("Lunch plans".matches_pattern("lunc?*", false)); assert!("LUNCH".matches_pattern("lunc?*", false)); assert!(!" lunch".matches_pattern("lunc?*", false)); diff --git a/crates/ruma-identifiers-validation/CHANGELOG.md b/crates/ruma-identifiers-validation/CHANGELOG.md index 7de13aad..8cc0e94d 100644 --- a/crates/ruma-identifiers-validation/CHANGELOG.md +++ b/crates/ruma-identifiers-validation/CHANGELOG.md @@ -1,5 +1,9 @@ # [unreleased] +Improvements: + +- Point links to the Matrix 1.9 specification + # 0.9.3 Improvements: diff --git a/crates/ruma-identifiers-validation/src/error.rs b/crates/ruma-identifiers-validation/src/error.rs index 0f4f0c61..70cf2fb6 100644 --- a/crates/ruma-identifiers-validation/src/error.rs +++ b/crates/ruma-identifiers-validation/src/error.rs @@ -77,7 +77,7 @@ pub enum MxcUriError { /// Media identifier malformed due to invalid characters detected. /// /// Valid characters are (in regex notation) `[A-Za-z0-9_-]+`. - /// See [here](https://spec.matrix.org/v1.8/client-server-api/#security-considerations-5) for more details. + /// See [here](https://spec.matrix.org/v1.9/client-server-api/#security-considerations-5) for more details. #[error("Media Identifier malformed, invalid characters")] MediaIdMalformed, diff --git a/crates/ruma-identifiers-validation/src/mxc_uri.rs b/crates/ruma-identifiers-validation/src/mxc_uri.rs index 54021c2e..da362af8 100644 --- a/crates/ruma-identifiers-validation/src/mxc_uri.rs +++ b/crates/ruma-identifiers-validation/src/mxc_uri.rs @@ -17,7 +17,7 @@ pub fn validate(uri: &str) -> Result { let server_name = &uri[..index]; let media_id = &uri[index + 1..]; - // See: https://spec.matrix.org/v1.8/client-server-api/#security-considerations-5 + // See: https://spec.matrix.org/v1.9/client-server-api/#security-considerations-5 let media_id_is_valid = media_id.bytes().all(|b| matches!(b, b'0'..=b'9' | b'a'..=b'z' | b'A'..=b'Z' | b'-' )); diff --git a/xtask/src/ci/spec_links.rs b/xtask/src/ci/spec_links.rs index d467924c..4d76f04e 100644 --- a/xtask/src/ci/spec_links.rs +++ b/xtask/src/ci/spec_links.rs @@ -18,7 +18,7 @@ const OLD_URL_WHITELIST: &[&str] = /// Authorized versions in URLs pointing to the new specs. const NEW_VERSION_WHITELIST: &[&str] = &[ - "v1.1", "v1.2", "v1.3", "v1.4", "v1.5", "v1.6", "v1.7", "v1.8", + "v1.1", "v1.2", "v1.3", "v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "latest", // This should only be enabled if a legitimate use case is found. // "unstable",