Error in documentation

[ufechner7]

The docs say, see: https://juliaarrays.github.io/StaticArrays.jl/stable/api/#Mutable-arrays:-MVector,-MMatrix-and-MArray

As a consequence of Julia's internal implementation, these mutable containers 
live on the heap, not the stack. Their memory must be allocated and 
tracked by the garbage collector. 

To the best of my knowledge this is wrong.

Instead I would write:

In Julia, MVectors are generally allocated on the stack when possible, but this is not 
a strict guarantee—specific cases, like use in mutable structs or certain compiler 
contexts, may result in heap allocation instead.

[mateuszbaran]

Yes, the current phrasing is wrong but I'd say that "MVectors are generally allocated on the stack when possible" is misleading because Julia still doesn't have inter-procedural escape analysis that could track when stack allocation is actually possible. Using MArrays without allocations is doable but it doing it consistently requires some knowledge about function inlining and Julia's IR.

It would definitely be good to improve documentation here.