Include type constraints in documentation
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
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- fsharp
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với tài liệu tham chiếu được liên kết về hash và compare, rồi xem xét workflow tạo tài liệu API của repository. So sánh các tham số kiểu được ghi trong tài liệu với danh sách các ràng buộc F# được liên kết, sau đó cập nhật các đầu vào tài liệu liên quan để các API bị ảnh hưởng hiển thị các ràng buộc của chúng và xác minh các trang đã tạo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The documentation for hash does not say that it requires the equality constraint on its only type parameter. Another example is the documentation for compare. It requires the comparison type constraint on its only type parameter. For convenience, here is the list of all type constraints.
Could type constraints be added to the documentation for types that have them?
- 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 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
fsharp/fsharp-core-docs#82 ·
-
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 ·
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