Inaccurate/misleading description of max in operators module (wrt. NaN comparison)
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 38/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Xem xét các mục tài liệu được tạo cho max và compare được liên kết trong issue, sau đó tái hiện các ví dụ NaN được nêu để xác nhận hành vi. Xác định xem sự khác biệt có nằm trong dự kiến hay không; được coi là hoàn tất khi tài liệu giải thích chính xác hành vi NaN của max hoặc issue được chứng minh là một bug cần một bản sửa riêng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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?
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 37
- Fork
- 20
- Merge trung bình
- 5 phút
- Pull request đã merge (30 ngày)
- 2
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của fsharp/fsharp-core-docs
-
Missing namespaces? Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
fsharp/fsharp-core-docs#104 · 6 bình luận ·
-
Build doesn't work on Linux? Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
fsharp/fsharp-core-docs#103 · 4 bình luận ·
-
Move to docs.fsharp.org? Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
fsharp/fsharp-core-docs#76 · 4 bình luận · 9 reaction ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
fsharp/fsharp-core-docs#75 · 3 bình luận · 1 reaction ·
-
fsdocs
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
fsharp/fsharp-core-docs#65 · 5 bình luận ·
Tất cả issue của fsharp/fsharp-core-docs
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
Git-it-App/git-it-electron#1047 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
neondatabase/website#5944 ·
-
📕documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
db-ux-design-system/core-web#8239 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
libsdl-org/sdlwiki#1008 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100