Document the semantics of `OpenMode`

オープン
#86 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

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

調査の方向性

OpenMode の定義とリンクされた pull request の議論から始めて、既存の動作を確認してください。読み取りモードが存在しないファイルに対して失敗するかどうか、またファイルを異なるモードで複数回開けるかどうかを、関連する例と期待される結果を含めて文書化してください。

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

説明

documentation good first issue

First mentioned here: https://github.com/input-output-hk/fs-sim/pull/85#discussion_r1895619049

The semantics of OpenMode are not properly documented anywhere. For example, opening a file in read mode should/will throw an error if the file does not exist, but this is not documented. More importantly, it is not documented whether files can be opened multiple times in different modes: for example, can a file be opened in both read- and write-mode?

主要言語
Haskell
スター
2
フォーク
6
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

IntersectMBO/fs-sim のほかの issue

IntersectMBO/fs-sim の issue をすべて見る

似ている issue

Haskell の issue をもっと見る

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

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