Docs: usage of j vs i
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- julia
- Domain
- documentation
Research direction
Open the linked RecursiveArrayTools.VectorOfArray documentation section and review the surrounding index-notation examples. Update the sentence describing vecarr_to_vectors and the plot recipe so its component-index notation is consistent with the preceding examples. Done means the documented index variable is consistent throughout that section.
Written by the indexing model from the issue text.
Description
Currently the documentation for VectorOfArray states:
A[i] # Returns the ith array in the vector of arrays
A[j, i] # Returns the jth component in the ith array
A[j1, ..., jN, i] # Returns the (j1,...,jN) component of the ith array
Followed by this sentence:
"Also, vecarr_to_vectors(VA::AbstractVectorOfArray) returns a vector of the series for each component, that is, A[i,:] for each i. A plot recipe is provided, which plots the A[i,:] series."
I think the choice of i is pretty confusing in this sentence as j is used before to represent the component index. For consistency I propose using j:
"Also, vecarr_to_vectors(VA::AbstractVectorOfArray) returns a vector of the series for each component, that is, A[j,:] for each j. A plot recipe is provided, which plots the A[j,:] series."
- Dominant language
- Julia
- Stars
- 233
- Forks
- 76
- Avg merge
- 2h 17m
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SciML/RecursiveArrayTools.jl
-
JET: similar_type(::Any) no-matching-method in RecursiveArrayToolsRaggedArrays (pre-existing QA red) Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
SciML/RecursiveArrayTools.jl#620 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
SciML/RecursiveArrayTools.jl#619 ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 45/100
SciML/RecursiveArrayTools.jl#570 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 28/100
SciML/RecursiveArrayTools.jl#522 ·
-
tagbot-manual
Difficulty 1/5 Under an hour Newbie friendliness 45/100
SciML/RecursiveArrayTools.jl#512 ·
All issues in SciML/RecursiveArrayTools.jl
Similar issues
-
bug 🐞 distributed 🕸️
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
CliMA/Oceananigans.jl#6049 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
JuliaGPU/GPUArrays.jl#780 ·
-
Difficulty 2/5 Half a day Newbie friendliness 76/100
epiforecasts/EpiBranch.jl#304 ·