Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Clarify the drawbacks of unsafe functions

Aperta
#305 4 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
haskell
Ambito
documentation

Direzione di ricerca

Inizia con la documentazione del modulo e la documentazione delle funzioni head e unsafe menzionate nell’issue. Verifica come si comporta un vettore vuoto passato a head e come falliscono le funzioni unsafe; la documentazione è completa quando avverte chiaramente dell’errore a runtime e di un possibile segmentation fault.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation help-wanted

Hi, I'm opening this issue regarding the documentation of the following functions:
Screenshot from 2020-05-08 20-50-20

Nowhere in the module documentation or in those functions it is said clearly the fact that:

  • Given an empty vector, head will raise a runtime error;
  • unsafe functions 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 using unsafe functions (who are then closer than Rust’s unsafe than 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

Lingua principale
Haskell
Stelle
401
Fork
145
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di haskell/vector

Tutte le issue di haskell/vector

Issue simili

Altre issue su Haskell

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.