Config file undocumented?
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
Start by comparing the configuration file options with the options shown by codespell --help, focusing on whether each command-line option has a config equivalent and what values it accepts. Check how count and check-hidden are handled, then document the supported config syntax and verify that the examples work; the issue does not name any files or tests.
由索引模型根据 Issue 内容生成。
描述
I might have missed it but it seems to me that the config file is nearly undocumented.
I can see all (?) possible config options via codespell --help. But these are for the command line. It is not clear if this options do have an equivalent in the config file and what values they should have.
For example it seems that I can do count = True in the config file. But from reading --help it was not clear that True is the correct value.
Or --check-hidden is totally unclear. It works on command line but when I do check-hidden = True I got codespell: error: unrecognized arguments: True. So I don't know how to configure check-hidden via config file.
- 主要语言
- Python
- 星标
- 2.4k
- 派生
- 531
- 平均合并
- 15 小时 5 分钟
- 30 天内合并 PR
- 18
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
codespell-project/codespell 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
codespell-project/codespell#3997 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 63/100
codespell-project/codespell#3965 · 3 条评论 ·
维护者通常 1 天内回复
-
Add "marcos"可能已有人在做 @ekanshul 于 19 天前认领。 未关闭dictionary
难度 2/5 1-3 小时 新手友好度 72/100
codespell-project/codespell#3920 · 3 条评论 ·
维护者通常 1 天内回复
-
question
难度 3/5 1-2 天 新手友好度 55/100
codespell-project/codespell#4005 ·
维护者通常 1 天内回复
-
duplicate question
难度 2/5 1-3 小时 新手友好度 35/100
codespell-project/codespell#3998 ·
维护者通常 1 天内回复
查看 codespell-project/codespell 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
microsoft/agent-lightning#661 ·
维护者通常 2 天内回复
-
area/profiles comp/cli P3 type/feature
难度 2/5 1-3 小时 新手友好度 74/100
NousResearch/hermes-agent#146372 ·
维护者通常 1 天内回复
-
[BUG] OpenAI-compatible embedding model alias breaks embedder construction可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
[oblt-aw][autodoc] Document obs-aw-automerge contract and fix automerge doc inconsistencies可能已有人在做 @github-actions 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
GeoSeries scale and skew tests fail with pytest 9.2.0可能已有人在做 @jiayuasu 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复