LuaLS / LuaLS/LuaLS.github.io

Improve readability of annotation syntaxes

Aberta
#7 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

help wanted
Linguagem predominante
MDX
Estrelas
10
Forks
19
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

The [method currently used](http://localhost:3000/wiki/annotations/#understanding-this-page) for describing how to use annotations can be easy to understand at times:
`---@type `

And also impossible for mere mortals to understand:
`---@cast [+|-][, [+|-]...]`
`---@overload fun([param: type[, param: type...]]): [return_value[,return_value]]`

There must be a better way to represent these more complex syntaxes while also not using symbols regularly in use (`<`, `>`, `(`, `)`, `[`, `]`, `{`, `}`, `@`, `#`, `-`, `+`, `=`, `:`, `"`, `,`, `.`, `?`). Although now that I have listed some in-use symbols, I realize we really are quite limited. It is hard to explain a syntax that uses many symbols… using symbols.

I'm open to any suggestions on how this can be improved 🙂

Guia de contribuição

Abrir o 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.

Direção de pesquisa

Comece pela página vinculada annotations/#understanding-this-page e revise os exemplos de sintaxe complexa mostrados no issue. O issue não define uma substituição preferida nem um teste claro de conclusão; para considerar o trabalho concluído, seria necessário chegar a um acordo sobre uma notação mais legível e atualizar os exemplos da documentação.

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

Avaliação

Domínio
documentation
Tipo de issue
Documentação
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

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