Undocumented exception(s) in the Num module
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- ocaml
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start with the Num module exposed by nums.cma, focusing first on Num.power_num and its Invalid_argument behavior. Review the module's existing documentation and identify undocumented functions, exceptions, and conditions that can raise them. Done means the relevant Num functions and failure conditions are documented, including the power_num limitation described in the report.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Original bug ID: 7065
Reporter: SpiceGuid
Status: acknowledged (set by @gasche on 2015-11-28T20:19:38Z)
Resolution: open
Priority: low
Severity: feature
Target version: later
Category: documentation
Bug description
Some people assume they can compute square root or cubic root by providing
a 1/2 or 1/3 ratio argument to the Num.power_num function.
Unfortunately they can't :
# #load "nums.cma";;
# open Num;;
# int_of_num (Int 27 **/ (Int 1 // Int 3));;
Exception: Invalid_argument "power_num".
The problem is not they can't, the problem is they assume they can and are encouraged by the silent documentation to do so.
I suggest that all Num functions should be totally documented, including exceptions and conditions that can raise them.
- Ngôn ngữ chính
- OCaml
- Star
- 39
- Fork
- 29
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 ocaml/num
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
feature wish
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
Issue tương tự
-
documentation priority: low size: S status: needs triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
cubrid-lab/sqlalchemy-cubrid#1397 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation priority: low size: S status: needs triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
cubrid-lab/pycubrid#1307 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 80/100
kentcdodds/kcd-skills#32 ·
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
ShaftHQ/chaosengine-harness#139 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
🎉 Add Open Agent APIĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
jaywcjlove/awesome-mac#4850 ·
Maintainer thường phản hồi trong vòng 1 ngày