haskell / haskell/binary

Improve README.md

Đang mở
#28 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Haskell
Star
120
Fork
70
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The README.md file has been converted to Markdown and been slightly extended.

Here are some further changes I'd like to see:

Not sure if it's still portable to Hugs. We claim it is, but I doubt it.

The section about "Using binary". I think this section is not too helpful. It could be more structured of the alternatives and with links to the relevant haddocks.

Deriving binary instance section. This is outdated and missleading. We can now generate instances with GHCs generics. A small example of how to do so, or link to the haddocks, would be better suiting.

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

Hướng nghiên cứu

Bắt đầu bằng cách đọc README.md, tập trung vào khẳng định về tính khả chuyển của Hugs, phần “Using binary” và phần deriving. Kiểm tra các Haddocks hiện tại và hướng dẫn về GHC generics trước khi chỉnh sửa; công việc được xem là hoàn tất khi README mô tả chính xác tính khả chuyển, trình bày các lựa chọn sử dụng cùng những liên kết phù hợp, và chỉ ra hoặc liên kết đến cách tiếp cận hiện đại để tạo instance.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
haskell
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
42/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.