processing / processing/processing-website
nf() function description inadequate
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- MDX
- Star
- 90
- Fork
- 122
- Merge trung bình
- 1 giờ 43 phút
- Pull request đã merge (30 ngày)
- 3
Mô tả
Issue description
nf() function reference could use a better description. As of now the text says:
Utility function for formatting numbers into strings. There are two versions: one for formatting floats, and one for formatting ints. The values for the digits and right parameters should always be positive integers. The left parameter should be positive or 0. If it is zero, only the right side is formatted.
This text only states that an int and a float version is existent. Nowhere is it explained how those are different. Referring to this description a call like nf(float, int) would be valid. This call however is not functional as passing num as a float variable requires to specify a left and right parameter (so the call has to be nf(float, int, int)).
This could be confusing to beginner programmers.
URL(s) of affected page(s)
https://processing.org/reference/nf_.html
Proposed fix
In my opinion ideally, in line with single responsibility, these would be two functions.
However an extended description should also do the trick.
The text could be extended by a paragraph similar to:
When num is a variable of type float the call becomes
nf(num, left, right). left represents the formatted number left of the decimal point and right represents the formatting right of the decimal point.
Alternatively it could be made clear in the Syntax and Parameter section which call allows which parameters.
nf(numf, left, right)
nf(numsf, left, right)
numf = float: the number to format
numsf = float[]: the numbers to format
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.
Hướng nghiên cứu
Mở trang tham chiếu nf() bị ảnh hưởng tại processing.org/reference/nf_.html và xem lại phần mô tả hiện tại cùng các phần Syntax và Parameter. Làm rõ các dạng gọi khác nhau và các tham số bắt buộc đối với đầu vào float và array. Công việc hoàn tất khi người mới bắt đầu có thể xác định chữ ký nào áp dụng cho từng kiểu đầu vào.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 55/100