Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

IO inaccuracies in documentation

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

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
documentation

调研方向

定位关于输入列、已解析输出和 --full-rerun 选项的文档,然后根据当前命令行为验证每一项陈述。更新文档,描述 nullable-but-required 的 scientific_name、source_id、有条件的 .resolved/.unsolved 输出以及 .forced;在单独的功能决策得到解决之前,记录 common-names manifest 的实际行为。

由索引模型根据 Issue 内容生成。

描述

documentation
  • scientific_name is a required input field. It may be null, but the column must be present for validation. Current docs describe it as optional, which is misleading as-is.
  • input columns should mention source_id
  • output files documentation implies a .resolved and .unsolved file will always be written for every resolve command input. But resolve might not include .unsolved if everything that is written goes into .resolved (misleading as-is). Also forgot to mention .forced.
  • --full-rerun doesn't affect common names manifest. This functionality (or lack thereof) should be clarified, and separately decided on whether or not it should exist in some form.
主要语言
Python
星标
19
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

我们还没有检查这个项目的环境配置文件。先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

Imageomics/TaxonoPy 的其他 Issue

查看 Imageomics/TaxonoPy 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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