Skip to content

Commit 0ec11c7

Browse files
committed
update docs
1 parent 2acfe63 commit 0ec11c7

2 files changed

Lines changed: 26 additions & 4 deletions

File tree

docs/src/index.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,31 @@ CurrentModule = BitPacking
66

77
Documentation for [BitPacking](https://github.com/MurrellGroup/BitPacking.jl).
88

9-
```@index
9+
## Contents
10+
11+
```@contents
12+
Pages = ["index.md"]
13+
```
14+
15+
## `bitwidth` interface for narrow types
16+
17+
```@docs
18+
bitwidth
1019
```
1120

12-
```@autodocs
13-
Modules = [BitPacking]
21+
## BitPackedArray
22+
23+
```@docs
24+
BitPackedArray
25+
bitpacked
26+
bitunpacked
27+
```
28+
29+
## Primitives
30+
31+
```@docs
32+
packbits!
33+
packbits
34+
unpackbits!
35+
unpackbits
1436
```

src/BitPackedArray.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ A wrapper for an array of packed bytes.
5757
Use [`bitpacked`](@ref) to create a `BitPackedArray`, and [`bitunpacked`](@ref) to unpack it.
5858
5959
!!! warning
60-
BitPackedArray has limited indexing support.
60+
Attempting to index into a `BitPackedArray` on GPUs may lead to scalar indexing errors.
6161
"""
6262
BitPackedArray
6363

0 commit comments

Comments
 (0)