Skip to content

Commit

Permalink
remove stuff about inbounds from the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MasonProtter committed Oct 9, 2023
1 parent d546012 commit 483d849
Showing 1 changed file with 0 additions and 10 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,6 @@
[![Build Status](https://github.com/JuliaSIMD/StrideArraysCore.jl/workflows/CI/badge.svg)](https://github.com/JuliaSIMD/StrideArraysCore.jl/actions)
[![Coverage](https://codecov.io/gh/JuliaSIMD/StrideArraysCore.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaSIMD/StrideArraysCore.jl)

### Caution

`StrideArraysCore` (and `StrideArray`s) does not check bounds by default. To enable bounds checking (for both), define
```julia
StrideArraysCore.boundscheck() = true
```
Note, bounds checking is still disabled when using `@inbounds`, even if `boundscheck() == false`.
Starting Julia with `--check-bounds=yes` will automatically redefine `StrideArraysCore.boundscheck() = true`.


Defines the core `PtrArray` type so that some libraries can make use of it internally without the need for circular dependencies.
[StrideArrays](https://github.com/chriselrod/StrideArrays.jl) extends this type with many methods and functionality. It is
recommended you depend on and use `StrideArrays` instead.
Expand Down

0 comments on commit 483d849

Please sign in to comment.