#documentation #chunks #cluster

doc-chunks

Clusters of doc comments and dev comments as coherent view

4 releases

0.0.5 Nov 23, 2022
0.0.4 Sep 15, 2022
0.0.3 Aug 19, 2022
0.0.1 May 25, 2022

#661 in Text processing

Download history 173/week @ 2022-10-18 192/week @ 2022-10-25 130/week @ 2022-11-01 141/week @ 2022-11-08 175/week @ 2022-11-15 399/week @ 2022-11-22 177/week @ 2022-11-29 188/week @ 2022-12-06 183/week @ 2022-12-13 174/week @ 2022-12-20 159/week @ 2022-12-27 144/week @ 2023-01-03 142/week @ 2023-01-10 159/week @ 2023-01-17 185/week @ 2023-01-24 147/week @ 2023-01-31

649 downloads per month
Used in cargo-spellcheck

MIT/Apache

160KB
3.5K SLoC

doc-chunks

Extract clustered documentation lines and provide a spanned and commonmark aware overlay with a span based mapping.


lib.rs:

Doc Chunks

Documentation is a representation of one or multiple documents.

A literal is a token provided by proc_macro2 or ra_ap_syntax crate, which is then converted by means of TrimmedLiteral using Clustering into a CheckableChunk (mostly named just chunk).

CheckableChunks can consist of multiple fragments, where each fragment can span multiple lines, yet each fragment is covering a consecutive Span in the origin content. Each fragment also has a direct mapping to the CheckableChunk internal string representation.

And Documentation holds one or many CheckableChunks per file path.

Dependencies

~6–12MB
~234K SLoC