SciML / SciML/RecursiveArrayTools.jl
Docs: usage of j vs i
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 233
- Forks
- 76
- Avg merge
- 2h 17m
- Merged PRs (30d)
- 9
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."
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.
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.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100