diff --git a/README.md b/README.md index d325b6e..75bbcd8 100644 --- a/README.md +++ b/README.md @@ -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.