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