Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

IO inaccuracies in documentation

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

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

評価

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

調査の方向性

入力列、解決済み出力、--full-rerun オプションのドキュメントを見つけ、各記述を現在のコマンドの動作に照らして検証する。ドキュメントを更新し、nullable-but-required である scientific_name、source_id、条件付きの .resolved/.unsolved 出力、および .forced について記述する。別個の機能に関する決定が解決されるまでの間、common-names マニフェストの実際の動作を記録する。

索引モデルが 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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Imageomics/TaxonoPy のほかの issue

Imageomics/TaxonoPy の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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