Improve documentation for IsSymbol
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 38/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- PureScript
- Étoiles
- 168
- Forks
- 90
- Merge moyen
- 3 j 1 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de purescript/purescript-prelude
-
Difficulté 2/5 1-3 heures Accessibilité débutants 57/100
purescript/purescript-prelude#317 · 1 réaction ·
-
Int bottom is not safeOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 32/100
purescript/purescript-prelude#312 · 5 commentaires ·
-
add liftCompare & friendsOuverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
purescript/purescript-prelude#310 · 5 commentaires ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 24/100
purescript/purescript-prelude#308 · 2 commentaires ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
purescript/purescript-prelude#307 · 1 commentaire · 1 réaction ·
Toutes les issues de purescript/purescript-prelude
Issues similaires
-
1.3 documentation
Difficulté 1/5 1-3 heures Accessibilité débutants 78/100
-
documentation Needs Human Review
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
NQCD/NQCDynamics.jl#526 ·
-
bug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 75/100
MetrolistGroup/Metrolist#4554 ·
Les mainteneurs répondent en général sous 1 jour
-
intake mcp-intake needs-human-review priority:high type:bug
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
Ikalus1988/MisakaNet#4903 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour