haskell / haskell/binary

Improve README.md

オープン
#28 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Haskell
スター
120
フォーク
70
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず README.md を読み、Hugs の移植性に関する主張、「Using binary」セクション、および deriving セクションに注目してください。編集する前に、現在の Haddocks と GHC generics に関するガイダンスを確認してください。README が移植性を正確に説明し、関連するリンク付きで使用方法の代替案を提示し、最新のインスタンス生成アプローチを示すかリンクしていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
haskell
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。