Example usage missing in docs

Aperta
  • Qualcosa non va?
#78 2 commenti 0 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
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

The issue points to the Data.Time module but names no documentation file or test. Read its docs and locate the main data type’s documentation; add a construction example based on the snippet in the issue. Done when the docs show a clear example of constructing a Time value.

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

Descrizione

type: documentation

Even a single example of how to construct the main data type in a module would be really helpful.
For example in Data.Time, you need a lot of understanding and experience to figure out that you're supposed to do something like:

import Data.Enum (toEnum)
myTime2 :: Maybe Time
myTime2 = Time <$> toEnum 11 <*> toEnum 30 <*> toEnum 59 <*> toEnum 213

I didn't have that experience... (Helpful people on #purescript-beginners Slack suggested the above.)
Would you consider adding that kind of example to the docs?

Lingua principale
PureScript
Stelle
51
Fork
48
Merge medio
2g 23h
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-datetime

Tutte le issue di purescript/purescript-datetime

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.