Improve documentation for IsSymbol

Aperta
  • Qualcosa non va?
#224 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
38/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Read the IsSymbol declaration and its comments at src/Data/Symbol.purs lines 11–13. Clarify what a “known symbol” means and explain that the compiler creates these instances. Done means newcomers can understand both points from the documentation.

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

Descrizione

type: documentation

https://github.com/purescript/purescript-prelude/blob/2b47992ab8c90db27cfc77b4f1b6e500ac2321e3/src/Data/Symbol.purs#L11-L13
As a newcomer who is currently trying to learn this, I don't understand what this is supposed to mean. What is a "known symbol"? I think better documentation would explicitly mention how the compiler will create these instances for you.

Lingua principale
PureScript
Stelle
168
Fork
90
Merge medio
3g 1h
PR unite (30g)
1

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

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 purescript/purescript-prelude

Tutte le issue di purescript/purescript-prelude

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.