Document possible CyclesInDeclaration error when using defaults

Offen
#139 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

Rechercherichtung

Read the Foldable instance documentation and the linked CycleInDeclaration error documentation to locate where this case belongs. Reproduce the reported foldl = foldlDefault cycle and confirm the suggested fold f = foldlDefault f form resolves it; done means the documentation explains the problem and its fix with a small example.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

type: documentation

I just bumped into the problem mentioned here https://stackoverflow.com/a/38490637/3237351 and the solution was also indeed to go from foldl = foldlDefault to fold f = foldlDefault f. It feels like this could be better documented in the Foldable instance. Maybe by simply giving a trivial example like the one in SO.

Possibly adding this case to the error documentation at https://github.com/purescript/documentation/blob/master/errors/CycleInDeclaration.md would also be a good idea. I'll submit an issue there too.

Vorherrschende Sprache
PureScript
Sterne
51
Forks
57
Ø Merge
3 T. 14 Min.
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-foldable-traversable

Alle Issues in purescript/purescript-foldable-traversable

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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