From b956178c534b339cb8f6517ac252d4b8929060ad Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Mon, 26 Apr 2021 22:44:19 +0200 Subject: [PATCH] client: Fix crate docs --- ruma-client/src/lib.rs | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/ruma-client/src/lib.rs b/ruma-client/src/lib.rs index b0deaa4e..17a465d5 100644 --- a/ruma-client/src/lib.rs +++ b/ruma-client/src/lib.rs @@ -40,7 +40,7 @@ //! ``` //! //! For the standard use case of synchronizing with the homeserver (i.e. getting all the latest -//! events), use the `Client::sync`: +//! events), use the `Client::sync` method: //! //! ```ignore //! use std::time::Duration; @@ -69,10 +69,8 @@ //! one with the given homeserver. //! //! Beyond these basic convenience methods, `ruma-client` gives you access to the entire Matrix -//! client-server API via the `api` module. Each leaf module under this tree of modules contains -//! the necessary types for one API endpoint. Simply call the module's `call` method, passing it -//! the logged in `Client` and the relevant `Request` type. `call` will return a future that will -//! resolve to the relevant `Response` type. +//! client-server API via the `request` method. You can pass it any of the `Request` types found in +//! `ruma::api::*` and get back a corresponding response from the homeserver. //! //! For example: //!