winglang/wing

Expose `@returns` in standard library docs

Open

#3169 aperta il 29 giu 2023

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (214 fork)github user discovery
good first issue🎨 sdk📚 documentation

Metriche repository

Star
 (5385 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina il file transpile/wing.ts di jsii docgen per capire come esporre le annotazioni @returns. Osserva i pattern di generazione della documentazione esistenti e aggiungi il supporto per il tag @returns.
Tech stack
typescript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.jsTypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70