Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: usage of j vs i #255

Open
muendlein opened this issue Mar 25, 2023 · 0 comments
Open

Docs: usage of j vs i #255

muendlein opened this issue Mar 25, 2023 · 0 comments

Comments

@muendlein
Copy link

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."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant