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

Haddocks for banned instances

Aperta
#2 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
haskell
Ambito
documentation

Direzione di ricerca

Start by inspecting how this Haskell project uses Template Haskell to ban instances and how Haddock renders the resulting declarations. Compare the generated documentation for a banned instance with the superclass declaration mentioned in the issue. Done means the Haddocks no longer suggest that a banned instance is available for use.

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

Descrizione

Banning an instance makes it appear in the haddocks as an instance, so if you're not careful and miss the instance TypeError (...) => in the superclass, you get the opposite impression: that there is actually an instance that you can use.

I don't think TH can generate haddocks yet.

Lingua principale
Haskell
Stelle
11
Fork
3
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 qfpl/ban-instance

Tutte le issue di qfpl/ban-instance

Issue simili

Altre issue su Haskell

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.