From cc631364f3f3e447ceffb439113861293186096f Mon Sep 17 00:00:00 2001 From: GiveMe-A-Name Date: Wed, 9 Aug 2023 09:13:31 +0800 Subject: [PATCH] chore: update the changeset & add a remark in docstring --- README.md | 4 ++-- src/lib.rs | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f37a018..b628943 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `lsp-textdocument` -A LSP text documents manager that map of text document. +A LSP text documents manager that helps mapping of textual content. ## Introduction @@ -39,4 +39,4 @@ fn main() { ## Attention -- The text documents positions-encoding only supports `UTF-16` +- The text documents [position-encoding](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#positionEncodingKind) only supports `UTF-16` diff --git a/src/lib.rs b/src/lib.rs index 534d32d..f835bbc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,8 @@ +//! +//! A LSP text documents manager that helps mapping of text document. +//! +//! The text documents [position-encoding](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#positionEncodingKind) only supports `UTF-16` + #![feature(int_roundings)] mod text_document; mod text_documents;