Inaccurate/misleading description of max in operators module (wrt. NaN comparison)
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 38/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
检查 issue 中链接的 max 和 compare 生成文档条目,然后重现所示的 NaN 示例以确认行为。确定这种差异是否符合预期;完成的标准是文档准确解释 max 的 NaN 行为,或证明该 issue 是一个需要单独修复的 bug。
由索引模型根据 Issue 内容生成。
描述
Not sure if this is an error in documentation or purposeful omission, or perhaps a bug in fsharp.
Here max is described as
Maximum based on generic comparison
And here compare is described as
Generic comparison.
However, even though they kind of boil down to the same thing in implementation for most types, they do not specifically for floating point numbers. Moreover, if one defines a max function with compare, for example like this:
let max2 x y = if compare x y < 0 then y else x
Then max2 behaves differently than max with respect to NaN, e.g.:
> max2 1. nan;;
val it: float = 1.0
> max2 nan 1.;;
val it: float = 1.0
whereas
> max nan 1.;;
val it: float = nan
> max 1. nan;;
val it: float = nan
If this discrepancy in behavior is expected, then perhaps it should be documented?
- 主要语言
- 没有语言数据
- 星标
- 37
- 派生
- 20
- 平均合并
- 5 分钟
- 30 天内合并 PR
- 2
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 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 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
fsharp/fsharp-core-docs#76 · 4 条评论 · 9 个 reaction ·
-
难度 5/5 一周以上 新手友好度 25/100
fsharp/fsharp-core-docs#75 · 3 条评论 · 1 个 reaction ·
-
fsdocs
难度 3/5 1-2 天 新手友好度 45/100
fsharp/fsharp-core-docs#65 · 5 条评论 ·
查看 fsharp/fsharp-core-docs 的全部 Issue
相似的 Issue
-
📕documentation
难度 2/5 1-3 小时 新手友好度 72/100
db-ux-design-system/core-web#8343 ·
维护者通常 1 天内回复
-
enhancement triage/needs-triage
难度 2/5 1-3 小时 新手友好度 88/100
heygen-com/hyperframes#4944 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
status:untriaged
难度 1/5 1 小时以内 新手友好度 92/100
midnightntwrk/midnight-wallet#790 ·
维护者通常 1 天内回复
-
component:midnight-toolkit status:untriaged
难度 2/5 1-3 小时 新手友好度 72/100
midnightntwrk/midnight-node#2237 ·
维护者通常 1 天内回复