Merge pull request #30403 from tkf/doc-propagate_inbounds

Include @propagate_inbounds docstring in documentation
JuliaLang · Mar 14, 2019 · 9f69b2e · 9f69b2e · nanosoldier · Mar 15, 2019
2 parents a168bc8 + af69665
commit 9f69b2e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/src/base/base.md b/doc/src/base/base.md
@@ -243,6 +243,7 @@ Base.evalfile
 Base.esc
 Base.@inbounds
 Base.@boundscheck
+Base.@propagate_inbounds
 Base.@inline
 Base.@noinline
 Base.@nospecialize

diff --git a/doc/src/devdocs/boundscheck.md b/doc/src/devdocs/boundscheck.md
@@ -43,8 +43,9 @@ between the `@inbounds` and `@boundscheck` declarations. For instance, the defau
 methods have the chain `getindex(A::AbstractArray, i::Real)` calls `getindex(IndexStyle(A), A, i)`
 calls `_getindex(::IndexLinear, A, i)`.
 
-To override the "one layer of inlining" rule, a function may be marked with `@propagate_inbounds`
-to propagate an inbounds context (or out of bounds context) through one additional layer of inlining.
+To override the "one layer of inlining" rule, a function may be marked with
+[`Base.@propagate_inbounds`](@ref) to propagate an inbounds context (or out of bounds
+context) through one additional layer of inlining.
 
 ## The bounds checking call hierarchy