winglang/wing

Expose `@returns` in standard library docs

Open

#3.169 aberto em 29 de jun. de 2023

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue🎨 sdk📚 documentation

Métricas do repositório

Stars
 (5.385 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Inspecione o arquivo transpile/wing.ts do jsii docgen para entender como expor anotações @returns. Observe os padrões de geração de documentação existentes e adicione suporte para a tag @returns.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitNode.jsTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70