FSharp docs expose pre-release functionality
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- fsharp
調査の方向性
.github/workflows/docs.yml の29行目から始め、ドキュメントのビルドが対象としている FSharp.Core と .NET のバージョンを確認します。生成されたドキュメントが Keys などの API をどのように公開しているかを確認し、pre-release 機能が意図されたものかどうかを明らかにします。対応バージョンが明確になり、pre-release API が除外されるか、明確に識別されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
My main question is: Is it intentional to have the docs show pre-release functionality?
I was writing a little app and forgot some syntax when using map. I checked the docs and noticed that it exposed a Keys property. I tried to use that instead of what I was doing. After a bit of poking to see if I was somehow missing a namespace I was helped by another engineer who said that Keys is a dotnet 6 feature. I then tried to answer the question "What of this can I use, and what can't I use yet?" which I was unable to do easily.
If this isn't intentional, I could see a number of ways to help:
- Build the docs not off of main, but off a release branch.
- Build off the main branch, but leave it to maintainers to mark functionality "pre-release" through an attribute and remove them when the functionality reaches the current dotnet version
- This would probably be a larger effort, but enhance the docs so they can be contextual based on the dotnet version similar to how the Microsoft docs here work
- 主要言語
- 言語のデータがありません
- スター
- 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 件 ·
-
fsdocs
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
fsharp/fsharp-core-docs#65 · コメント 5 件 ·
fsharp/fsharp-core-docs の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
Git-it-App/git-it-electron#1047 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
neondatabase/website#5944 ·
-
📕documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
db-ux-design-system/core-web#8239 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
libsdl-org/sdlwiki#1008 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100