Clarify the drawbacks of unsafe functions
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- haskell
- Área
- documentation
Línea de trabajo
Comienza con la documentación del módulo y la documentación de las funciones head y unsafe mencionadas en el issue. Verifica cómo se comporta un vector vacío pasado a head y cómo fallan las funciones unsafe; la documentación estará terminada cuando advierta claramente sobre el error en tiempo de ejecución y un posible segmentation fault.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Hi, I'm opening this issue regarding the documentation of the following functions:
Nowhere in the module documentation or in those functions it is said clearly the fact that:
- Given an empty vector,
headwill raise a runtime error; unsafefunctions do not lead to RTS exceptions (like they may do in other container-like APIs), but will segfault the program. Beginners and more generally people who did not experience this behaviour first-hand are in no way warned of the implications of usingunsafefunctions (who are then closer than Rust’sunsafethan the commonly accepted definition of safety in the Haskell ecosystem).
I personally think it is dangerous to leave such gaps in the documentation and wanted to discuss this with the maintainers before opening a PR to rectify this.
cc @cartazio
- 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
-
status: needs triage type: enhancement
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
haskell/haskell-language-server#5128 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
alunduil/siren-json.hs#246 ·
Los mantenedores suelen responder en 1 día
-
frontend Hackathon
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
flora-pm/flora-server#1334 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
question
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
NixOS/SC-election-2026#44 · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Recognise more linters: yamllint, hlint, luacheck, sqlfluff, buf, tflint, swiftformat --lintAbiertoenhancement good first issue hacktoberfest runner
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100