FSharp docs expose pre-release functionality
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- fsharp
调研方向
从第 29 行的 .github/workflows/docs.yml 开始，确定文档构建所针对的 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 分钟
- 30 天内合并 PR
- 2
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
fsharp/fsharp-core-docs 的其他 Issue
-
难度 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 一周以上 新手友好度 25/100
fsharp/fsharp-core-docs#76 · 4 条评论 · 9 个 reaction ·
-
fsdocs
难度 3/5 1-2 天 新手友好度 45/100
fsharp/fsharp-core-docs#65 · 5 条评论 ·
查看 fsharp/fsharp-core-docs 的全部 Issue
相似的 Issue
-
Crush 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
catppuccin/catppuccin#3125 ·
-
automated issue report
难度 1/5 1 小时以内 新手友好度 95/100
-
难度 1/5 1 小时以内 新手友好度 90/100
VoltAgent/awesome-design-md#469 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
KhronosGroup/glTF#2648 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
sccn/sccn.github.io#108 ·