From c7c11b2f3eab6f405b64ee93d60f136d5975a551 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Mon, 8 Feb 2021 20:47:10 +0100 Subject: [PATCH] Add more documentation about ruma crate features --- ruma/src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/ruma/src/lib.rs b/ruma/src/lib.rs index bdb014bd..66c110e8 100644 --- a/ruma/src/lib.rs +++ b/ruma/src/lib.rs @@ -10,6 +10,12 @@ //! * `client-api` for the client-server API //! * `federation-api` for the server-server (federation) API //! * `appservice-api` for the application service API +//! +//! There's also the features `api`, `events` and `signatures` for the +//! submodules of the same names. Usually they are activated by one of the +//! other features when needed. If you are viewing this on `docs.rs`, you can +//! have a look at the feature dependencies by clicking 'Feature flags' in the +//! toolbar at the top. #![deny(missing_docs)] #![cfg_attr(docsrs, feature(doc_cfg))]