LuaLS / LuaLS/LuaLS.github.io

Improve readability of annotation syntaxes

Offen
#7 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

help wanted
Vorherrschende Sprache
MDX
Sterne
10
Forks
19
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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 🙂

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der verlinkten Seite annotations/#understanding-this-page und prüfen Sie die im Issue gezeigten Beispiele für komplexe Syntax. Das Issue definiert weder einen bevorzugten Ersatz noch einen klaren Abschlusstest; abgeschlossen wäre die Aufgabe erst, wenn eine besser lesbare Notation vereinbart und die Dokumentationsbeispiele aktualisiert wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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