winglang/wing

Expose `@returns` in standard library docs

Open

#3,169 opened on 2023幎6月29日

GitHub で芋る
 (4 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue🎚 sdk📚 documentation

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (30d に merged 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
Issue 皮別
ドキュメント
難床新しい貢献者にずっおの実装難床です。1 は非垞に小さな倉曎、5 は専門的な䜜業です。
2
掚定時間経隓ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
掻動状況Issue が今どれだけ取り組みやすいかを瀺したす。新しい、掻発、叀い、ブロック䞭、たたはメンテナヌ入力埅ちなどです。
アクティブ
明確さ期埅される倉曎、受け入れ条件、次の手順がどれだけ明確かを瀺したす。
明確
前提条件
GitNode.jsTypeScript
初心者向け床初回貢献者にどれだけ取り組みやすいかを 1-100 で掚定したスコアです。
70