Improve documentation for IsSymbol

Aberta
  • Algo errado?
#224 1 comentário 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
38/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

type: documentation

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.

Linguagem predominante
PureScript
Estrelas
168
Forks
90
Merge médio
3d 1h
PRs com merge (30d)
1

Preparar o ambiente

  • Sem Dockerfile nem arquivo Docker Compose
  • Tem um modelo de pull request
  • Sem guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de purescript/purescript-prelude

Todas as issues de purescript/purescript-prelude

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.