From ed2f6688c3fbba6cd5ccf3b606b502f582e5ad5d Mon Sep 17 00:00:00 2001 From: alemi Date: Tue, 5 Sep 2023 01:31:57 +0200 Subject: [PATCH] docs: mentioned Instance early on --- src/lib.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 3570314..515af53 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,8 +5,9 @@ //! This is the core library of the codemp project. //! //! ## structure -//! The main entrypoint is the [Client] object, that maintains a connection and can -//! be used to join workspaces or attach to buffers. +//! The main entrypoint is the [Instance] object, that maintains a connection and can +//! be used to join workspaces or attach to buffers. It contains the underlying [Client] and +//! stores active controllers. //! //! Some actions will return structs implementing the [Controller] trait. These can be polled //! for new stream events ([Controller::poll]/[Controller::recv]), which will be returned in order.