Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-09-20 06:22:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

line-index: Update README.md with suggestions

Browse source 
Co-authored-by: Laurențiu Nicola <lnicola@users.noreply.github.com>
This commit is contained in:
homersimpsons 2024-01-07 15:38:40 +01:00 committed by GitHub
parent 747fa7dd6e
commit 0f69276e60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/line-index/README.md
View file

@ -1,8 +1,8 @@
# line-index
This crate is developped as part of `rust-analyzer`.
This crate is developed as part of `rust-analyzer`.
line-index is a library to convert between text offset and its corresponding line/column.
line-index is a library to convert between text offsets and corresponding line/column coordinates.
## Installation
@ -10,7 +10,9 @@ To add this crate to a project simply run `cargo add line-index`.
## Usage
The main structure is `LineIndex`. It is constructed with an utf-8 text then various utility functions can be used on it.
The main structure is `LineIndex`.
It is constructed with an UTF-8 string, but also supports UTF-16 and UTF-32 offsets.
### Example
@ -25,4 +27,4 @@ line_index.offset(LineCol { line: 2, col: 3 }); // Some (24)
## SemVer
This crate follows [semver principles]([url](https://semver.org/)https://semver.org/).
This crate uses [semver](https://semver.org/) versioning.