Skip to content

Commit b482f3d

Browse files
authored
chore: clean up docs and restructure sections (#2459)
1 parent 60546c0 commit b482f3d

File tree

18 files changed

+452
-454
lines changed

18 files changed

+452
-454
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/concepts/arrays.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,27 @@ is an overview:
4242
* `into_canonical`: decodes the array into a canonical encoding.
4343
* `into_arrow`: decodes the array into an Arrow array.
4444
* `metadata`
45-
* `validate`: validates the array's metadata buffer.
46-
* `display`: returns a human-readable representation of the array metadata.
45+
* `validate`: validates the array's metadata buffer.
46+
* `display`: returns a human-readable representation of the array metadata.
4747
* `validity`
48-
* `is_valid`: returns whether the element at a given row is valid.
49-
* `all_valid`: returns whether all elements are valid.
50-
* `invalid_count` returns the number of invalid elements.
51-
* `validity_mask`: returns the validity bit-mask for an array, indicating which values are non-null.
48+
* `is_valid`: returns whether the element at a given row is valid.
49+
* `all_valid`: returns whether all elements are valid.
50+
* `invalid_count` returns the number of invalid elements.
51+
* `validity_mask`: returns the validity bit-mask for an array, indicating which values are non-null.
5252
* `compute`: a collection of compute functions vtables.
53-
* `filter`: a function for filtering the array using a given selection mask.
54-
* ...
53+
* `filter`: a function for filtering the array using a given selection mask.
54+
* ...
5555
* `statistics`: a function for computing a statistic for the array data, for example `min`.
5656
* `variants`: a collection of optional DType-specific functions for operation over the array.
57-
* `struct`: functions for operating over arrays with a `StructDType`.
58-
* `get_field`: returns the array for a given field of the struct.
59-
* ...
57+
* `struct`: functions for operating over arrays with a `StructDType`.
58+
* `get_field`: returns the array for a given field of the struct.
6059
* ...
60+
* ...
6161

6262
Encoding vtables can even be constructed from non-static sources, such as _WebAssembly_ modules, which enables the
6363
[forward compatibility](/specs/file-format.md#forward-compatibility) feature of the Vortex File Format.
6464

65-
See the [Writing an Encoding](/rust/writing-an-encoding) guide for more information.
65+
See the [Writing an Encoding](/guides/writing-an-encoding) guide for more information.
6666

6767
### Canonical Encodings
6868

@@ -132,13 +132,12 @@ alignment sufficient for SIMD unpacking operations.
132132
Arrays carry their own statistics with them, allowing many compute functions to short-circuit or optimise their
133133
implementations. Currently, the available statistics are:
134134

135-
- `null_count`: The number of null values in the array.
136-
- `true_count`: The number of `true` values in a boolean array.
137-
- `run_count`: The number of consecutive runs in an array.
138-
- `is_constant`: Whether the array only holds a single unique value
139-
- `is_sorted`: Whether the array values are sorted.
140-
- `is_strict_sorted`: Whether the array values are sorted and unique.
141-
- `min`: The minimum value in the array.
142-
- `max`: The maximum value in the array.
143-
- `uncompressed_size`: The size of the array in memory before any compression.
144-
135+
* `null_count`: The number of null values in the array.
136+
* `true_count`: The number of `true` values in a boolean array.
137+
* `run_count`: The number of consecutive runs in an array.
138+
* `is_constant`: Whether the array only holds a single unique value
139+
* `is_sorted`: Whether the array values are sorted.
140+
* `is_strict_sorted`: Whether the array values are sorted and unique.
141+
* `min`: The minimum value in the array.
142+
* `max`: The maximum value in the array.
143+
* `uncompressed_size`: The size of the array in memory before any compression.

0 commit comments

Comments
 (0)