From 4845594c05c323fa124be3452949d5761c268473 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Fri, 11 Feb 2022 12:49:43 +0100 Subject: [PATCH] ruma: Document the new unstable-mscXXXX features --- README.md | 7 +++++-- crates/ruma/src/lib.rs | 4 +++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b931245e..b2a831ba 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,11 @@ them. Check out the documentation [on docs.rs][docs] (or on As of 2022-01-31, we support all events and REST endpoints of the v1 version of the Matrix specification, with v1.1 and v1.2 coverage in progress. -Various changes from in-progress MSCs, finished MSCs, and a few less formalized -things are also implemented, gated behind the `unstable-pre-spec` Cargo feature. +Various changes from in-progress or finished MSCs are also implemented, gated +behind the `unstable-mscXXXX` (where `XXXX` is the MSC number) Cargo features. + +A few less formalized things are gated behind the `unstable-pre-spec` Cargo +feature. ## Contributing diff --git a/crates/ruma/src/lib.rs b/crates/ruma/src/lib.rs index 14504230..02dcbd41 100644 --- a/crates/ruma/src/lib.rs +++ b/crates/ruma/src/lib.rs @@ -45,7 +45,9 @@ //! * `unstable-exhaustive-types` -- Most types in Ruma are marked as non-exhaustive to avoid //! breaking changes when new fields are added in the specification. This feature compiles all //! types as exhaustive. -//! * `unstable-pre-spec` -- Upcoming Matrix features that may be subject to change or removal. +//! * `unstable-mscXXXX`, where `XXXX` is the MSC number -- Upcoming Matrix features that may be +//! subject to change or removal. +//! * `unstable-pre-spec` -- Undocumented Matrix features that may be subject to change or removal. //! //! # Common features //!