winglang/wing

Expose `@returns` in standard library docs

Open

#3,169 创建于 2023年6月29日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)TypeScript (214 fork)github user discovery
good first issue🎨 sdk📚 documentation

仓库指标

Star
 (5,385 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
检查 jsii docgen 的 transpile/wing.ts 文件，了解如何暴露 @returns 注释。查看现有的文档生成模式，并添加对 @returns 标签的支持。
技术栈
typescript
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitNode.jsTypeScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70