Discuss member panels
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- fsharp
調査の方向性
まず、ここで参照されている FSharp.Core の XML コメントとの関連で、FSharp.Formatting の member-panel 生成を確認します。提案されている型とパラメーターの統合された説明、メンバーごとのページ、縦方向のレイアウト、概要のみのリストを PyTorch の例と比較します。完了とは、設計上の決定を確定し、文書化することです。
索引モデルが issue の本文から書いたものです。
説明
Hi all,
I'd like to discuss the member panels (and the documentation for members more generally) coming out of FSharp.Formatting. I think it's good to do this in the context of FSharp.Core where we have relatively populated XML comments, though it's a more general FSharp.Formatting issue
For FSharp.Core a typical member panel looks like this:
Now, the things I'd like some help with are
-
Should the parameter types and the parameter descriptions be merged together? The F#F codebase is now getting to a point where it's cleaned up enough (and I understand it well enough) to allow this to happen. But what visuals do we want? Are there any really nice docs elsewhere integrating type information and documentation you can point me to?
-
Do we actually need to move to generating one page per member, especially when example usage starts being added? A library like PyTorch doesn't do this but of course MSDN does.
-
The left-right display of the member usage feels like wasted space. Perhaps each member should be stacked.
Here's an example of PyTorch (not necesarily great documentation though nor exemplar for FSHarp.Core)
Member list:
Member page:
The things I notice are:
-
one page for each member
-
vertical stacking
-
types go in italics , parenthesized
-
only summary text on member list page
- 主要言語
- 言語のデータがありません
- スター
- 37
- フォーク
- 20
- 平均マージ
- 5分
- マージ済み PR（30日）
- 2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
fsharp/fsharp-core-docs のほかの issue
-
Missing namespaces? オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
fsharp/fsharp-core-docs#104 · コメント 6 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#103 · コメント 4 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
fsharp/fsharp-core-docs#82 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#76 · コメント 4 件 · リアクション 9 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#75 · コメント 3 件 · リアクション 1 件 ·
fsharp/fsharp-core-docs の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100