chore: update the changeset & add a remark in docstring

GiveMe-A-Name · Aug 9, 2023 · cc63136 · cc63136
1 parent df7800d
commit cc63136
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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;