google / google/codeworld

Parameter names in auto-generated docs for builtin symbols

オープン
#815 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Haskell
スター
1.3k
フォーク
201
PR マージ指標
30日以内にマージされた PR はありません

説明

The autogenerated docs for built-in symbols currently just have a line number. In certain cases (at least when it's easy) it would be great to include the parameter names from a function declaration. There are hard cases, such as when a function has multiple parameters and doesn't use the same name each time -- or even pattern matches so there is no name for the overall parameter. It's okay to skip these (except for tuples, of course).

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

ファイルやテストは指定されていません。組み込みシンボルのドキュメントを生成するコードをまず特定し、関数宣言がどのように表現されているかを追跡してください。望ましい結果は、曖昧でない場合にはパラメーター名を表示し、サポートされていないケースはスキップし、それでもタプルを処理できるようにすることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
haskell
領域
documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。