winglang/wing

Expose `@returns` in standard library docs

Open

#3 169 ouverte le 29 juin 2023

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)TypeScript (214 forks)github user discovery
good first issue🎨 sdk📚 documentation

Métriques du dépôt

Stars
 (5 385 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Inspectez le fichier transpile/wing.ts de jsii docgen pour comprendre comment exposer les annotations @returns. Examinez les modèles de génération de documentation existants et ajoutez la prise en charge de la balise @returns.
Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.jsTypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70