Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Improve readability of annotation syntaxes

Offen
  • Stimmt etwas nicht?
#7 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

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.

Beschreibung

help wanted

The method currently used for describing how to use annotations can be easy to understand at times:
---@type <type>

And also impossible for mere mortals to understand:
---@cast <value_name> [+|-]<type|?>[, [+|-]<type|?>...]
---@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 🙂

Vorherrschende Sprache
MDX
Sterne
10
Forks
19
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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