Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Include type constraints in documentation

オープン
#65 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
fsharp
領域
documentation

調査の方向性

リンクされている hash と compare のリファレンスドキュメントから始め、リポジトリの生成 API ドキュメントのワークフローを確認します。ドキュメント化されている型パラメーターと、リンク先の F# 制約の一覧を比較し、影響を受ける API に制約が表示されるよう関連するドキュメント入力を更新して、生成されたページを検証します。

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

説明

fsdocs

The documentation for hash does not say that it requires the equality constraint on its only type parameter. Another example is the documentation for compare. It requires the comparison type constraint on its only type parameter. For convenience, here is the list of all type constraints.

Could type constraints be added to the documentation for types that have them?

主要言語
言語のデータがありません
スター
37
フォーク
20
平均マージ
5分
マージ済み PR(30日)
2

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

fsharp/fsharp-core-docs のほかの issue

fsharp/fsharp-core-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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