Example usage missing in docs

Offen
  • Stimmt etwas nicht?
#78 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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?

Vorherrschende Sprache
PureScript
Sterne
51
Forks
48
Ø Merge
2 T. 23 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus purescript/purescript-datetime

Alle Issues in purescript/purescript-datetime

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.