Improve documentation for IsSymbol
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 38/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Bereich
- documentation
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- PureScript
- Sterne
- 168
- Forks
- 90
- Ø Merge
- 3 T. 1 Std.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus purescript/purescript-prelude
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 57/100
purescript/purescript-prelude#317 · 1 Reaktion ·
-
Int bottom is not safeOffen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 32/100
purescript/purescript-prelude#312 · 5 Kommentare ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
purescript/purescript-prelude#310 · 5 Kommentare ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 24/100
purescript/purescript-prelude#308 · 2 Kommentare ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
purescript/purescript-prelude#307 · 1 Kommentar · 1 Reaktion ·
Alle Issues in purescript/purescript-prelude
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
osrep/Runes2P.jl#279 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation good first issue help wanted
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 72/100
Is0cre/MonkeyThrive#6 ·
-
bug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 65/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Imbad0202/academic-research-skills#1093 ·
Maintainer antworten meist innerhalb von 1 Tag
-
1.3 documentation
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 78/100