Document the semantics of `OpenMode`

未关闭
#86 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
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

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

IntersectMBO/fs-sim 的其他 Issue

查看 IntersectMBO/fs-sim 的全部 Issue

相似的 Issue

更多 Haskell Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。