ruma: Document the new unstable-mscXXXX features

This commit is contained in:
Kévin Commaille 2022-02-11 12:49:43 +01:00
parent b9f32bc632
commit 4845594c05
No known key found for this signature in database
GPG Key ID: DD507DAE96E8245C
2 changed files with 8 additions and 3 deletions

View File

@ -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 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. 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 Various changes from in-progress or finished MSCs are also implemented, gated
things are also implemented, gated behind the `unstable-pre-spec` Cargo feature. 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 ## Contributing

View File

@ -45,7 +45,9 @@
//! * `unstable-exhaustive-types` -- Most types in Ruma are marked as non-exhaustive to avoid //! * `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 //! breaking changes when new fields are added in the specification. This feature compiles all
//! types as exhaustive. //! 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 //! # Common features
//! //!