Improve documentation and refactor `copy` + `move` in mutable APIs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Refactorización
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- haskell
- Área
- api, documentation
Línea de trabajo
Comienza con la documentación de Data-Vector-Mutable enlazada en el issue y compara los contratos documentados de copy y move. Determina si se aceptan los cambios de redacción solicitados y la gestión de solapamientos, o la propuesta de deprecación; se considera terminado cuando el comportamiento de la API y la documentación tienen un diseño definido y probado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
- Consider updating existing documentation for copy/move:
https://hackage.haskell.org/package/vector-0.13.0.0/docs/Data-Vector-Mutable.html#g:13
It's not clear what is the difference between "copy" and "move".
Consider changing "may" to a strong "must" and adding a line on what happens otherwise:
Copy a vector. The two vectors must have the same length and may not overlap.
To:
Copy contents of one vector to another.
The two vectors must have the same length and must not overlap.
An error is thrown if vectors have different lengths or if overlap.
It was unclear what is the meaning of "moving a vector" and what is the difference VS "copying data".
Consider explaining "move" in terms of "copy" and changing:
Move the contents of a vector. The two vectors must have the same length.
To:
Same as "copy", but allows vectors to overlap -- at additional cost, by allocating a temporary vector for copying.
- Improvement: consider deprecating "move", but make "copy" deal with overlapping vectors (at no additional cost -- see below).
In short: different copying order. If two vectors overlap, the order of copying offset + (zero..length) VS offset + (length..zero) can be chosen, depending on which of the two vectors (source and target) goes first in address (index) space. No need to allocate temporary memory.
- Lenguaje dominante
- Haskell
- Estrellas
- 403
- Forks
- 146
- Merge medio
- 1 d 22 h
- PR fusionados (30 d)
- 3
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 haskell/vector
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 50/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
-
`Size` can be a newtype.Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
Todos los issues de haskell/vector
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
halogenandtoast/ArkhamHorror#5825 · 1 comentario ·
-
docs: install-manifest download links use main instead of master (404)Posiblemente ocupada @ChinmayaBisoi la tomó hace 1 día. Abierto
Dificultad 2/5 Menos de una hora Aptitud para principiantes 78/100
hasura/graphql-engine#10884 ·
-
New-pipeline: update TracyAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
AccelerateHS/accelerate#583 · 2 comentarios ·
-
component: hls-refactor-plugin status: needs triage type: bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 60/100
haskell/haskell-language-server#5111 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
alunduil/network-arbitrary#193 ·
Los mantenedores suelen responder en 1 día