JuliaArrays / JuliaArrays/StaticArrays.jl

Error in documentation

Open
#1,316 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
844
Forks
159
Avg merge
3d 21h
Merged PRs (30d)
3

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Mutable arrays: MVector, MMatrix and MArray section in the API documentation and review the statement about heap allocation. Confirm the accurate Julia behavior before updating the wording, then build or preview the documentation to verify the revised text renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.