winglang/wing

Expose `@returns` in standard library docs

Open

#3.169 geöffnet am 29. Juni 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (214 Forks)github user discovery
good first issue🎨 sdk📚 documentation

Repository-Metriken

Stars
 (5.385 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

We should expose the @returns docstring of methods on our documentation.

For example - @returns for array.contains(...) (see the code here) should be exposed in the corresponding docs.

Implementation Notes

Probably a good place to start looking how to tweak our jsii-docgen extension to show the @returns annotation is this file: https://github.com/winglang/wing/blob/main/apps/jsii-docgen/src/docgen/transpile/wing.ts See the contribution docs for how to test doc changes locally.

Contributor Guide

Research-Richtung
Untersuche die Datei transpile/wing.ts von jsii docgen, um zu verstehen, wie @returns Annotationen offengelegt werden. Sieh dir die vorhandenen Muster zur Dokumentationsgenerierung an und füge Unterstützung für das @returns Tag hinzu.
Tech Stack
typescript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.jsTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70