haskell / haskell/binary

Document safety expectations, or the lack thereof

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

説明

I noticed that the instances for `Map`, `Set`, `IntMap`, and `IntSet` are "unsafe" in the sense that they will happily build structures that don't obey the expected invariants if they are presented with improperly ordered input. Is this acceptable behavior (i.e., is `get` only supposed to be used with trusted input)? Or should the invocations of `fromDistinctAscList` be replaced with `fromList`?

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

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

調査の方向性

Map、Set、IntMap、IntSetのインスタンスと、issueで言及されているfromDistinctAscListの呼び出しを確認します。getが信頼できる入力を対象としているのかを判断して安全性に関する期待事項を文書化するか、これらのコンストラクタを置き換えるべき場合に必要な動作を明確にします。完了には、プロジェクトとして明確な決定が必要です。

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

評価

技術スタック
haskell
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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