Docs: usage of j vs i
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 68/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- julia
- Área
- documentation
Línea de trabajo
Abre la sección enlazada de la documentación de RecursiveArrayTools.VectorOfArray y revisa los ejemplos de notación de índices que la rodean. Actualiza la oración que describe vecarr_to_vectors y la receta de plot para que su notación de índices de componentes sea coherente con los ejemplos anteriores. Se considera terminado cuando la variable de índice documentada sea coherente en toda esa sección.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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."
- Lenguaje dominante
- Julia
- Estrellas
- 233
- Forks
- 76
- Merge medio
- 2 h 17 min
- PR fusionados (30 d)
- 9
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de SciML/RecursiveArrayTools.jl
-
JET: similar_type(::Any) no-matching-method in RecursiveArrayToolsRaggedArrays (pre-existing QA red) Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
SciML/RecursiveArrayTools.jl#620 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
SciML/RecursiveArrayTools.jl#619 ·
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
SciML/RecursiveArrayTools.jl#570 ·
-
Re-enable downgrade CI tests Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 28/100
SciML/RecursiveArrayTools.jl#522 ·
-
tagbot-manual
Dificultad 1/5 Menos de una hora Aptitud para principiantes 45/100
SciML/RecursiveArrayTools.jl#512 ·
Todos los issues de SciML/RecursiveArrayTools.jl
Issues similares
-
bug 🐞 distributed 🕸️
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
CliMA/Oceananigans.jl#6049 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
epiforecasts/BVDOutbreakSize#790 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100