SciML / SciML/RecursiveArrayTools.jl

Documentation does not reflect deprecation of linear indexing

Open
#343 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Julia
Stars
233
Forks
76
Avg merge
2h 17m
Merged PRs (30d)
9

Description

The documentation does not reflect the deprecation of linear indexing (which I find a bit sad BTW):

https://github.com/SciML/RecursiveArrayTools.jl/blob/80f2c8621dc45f1ab5b3fa1ccd9a81111277c40f/src/vector_of_array.jl#L14

Contributor guide

Open the contributing guide

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 by reading src/vector_of_array.jl at line 14 to confirm how linear indexing is marked deprecated. Find the corresponding documentation section, update it to reflect that deprecation, and verify the rendered documentation no longer presents linear indexing as supported.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.