doc: update trim_doc_node_description, make module readmes more uniform (#20792)

This commit is contained in:
Turiiya 2024-02-12 17:38:47 +07:00 committed by GitHub
parent e3b64d3278
commit d485cceee8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
59 changed files with 186 additions and 150 deletions

View file

@ -1,8 +1,9 @@
## Description:
## Description
`compress` is a namespace for (multiple) compression algorithms supported by V.
At the moment, the following compression algorithms are implemented:
- `compress.deflate`
- `compress.gzip`
- `compress.zlib`

View file

@ -1,10 +1,9 @@
## Description:
## Description
`compress.deflate` is a module that assists in the compression and
decompression of binary data using `deflate` compression
## Examples:
## Example
```v
import compress.deflate

View file

@ -1,4 +1,4 @@
## Description:
## Description
`compress.gzip` is a module that assists in the compression and
decompression of binary data using `gzip` compression

View file

@ -18,7 +18,7 @@ fn test_reading_and_decoding_a_known_gziped_file() {
compressed, content := read_and_decode_file(s('known.gz'))!
assert compressed#[0..3] == [u8(31), 139, 8]
assert compressed#[-5..] == [u8(127), 115, 1, 0, 0]
assert content.contains('## Description:')
assert content.contains('## Description')
assert content.contains('## Examples:')
assert content.ends_with('```\n')
}

View file

@ -1,4 +1,4 @@
## Description:
## Description
`szip` is a thin wrapper around [miniz.h](https://github.com/richgel999/miniz),
which in turn is "Single C source file zlib-replacement library,

View file

@ -1,9 +1,9 @@
## Description:
## Description
`compress.zlib` is a module that assists in the compression and
decompression of binary data using `zlib` compression
## Examples:
## Examples
```v
import compress.zlib

View file

@ -1,4 +1,4 @@
## Description:
## Description
`compress.zstd` is a module that assists in the compression and
decompression of binary data using `zstd` compression.

View file

@ -18,7 +18,7 @@ fn test_reading_and_decoding_a_known_zstded_file() {
compressed, content := read_and_decode_file(s('known.zst'))!
assert compressed#[0..3] == [u8(40), 181, 47]
assert compressed#[-5..] == [u8(10), 78, 32, 170, 44]
assert content.contains('## Description:')
assert content.contains('## Description')
assert content.contains('## Examples:')
assert content.ends_with('```')
}