Skip to content

docs: 実装と異なる状態分類の説明と実行例を修正 - #1941

Merged
yuji38kwmt merged 2 commits into
mainfrom
docs/fix-implementation-mismatches
Nov 1, 2026
Merged

yuji38kwmt merged 2 commits into
mainfrom
docs/fix-implementation-mismatches

Conversation

@yuji38kwmt

Copy link
Copy Markdown
Collaborator

タスク数集計の説明と実行例に、現在の実装と一致しない記述がありました。task_count list_by_phaseの状態分類と作業時間の閾値が適用される条件を明記し、タスク検索条件のJSON、メタデータ確認のjq式、エンドポイント指定例の必須引数、属性制約のサンプルファイル名を修正します。

検証:

  • make format
  • make lint
  • make docs-check(警告なし)
  • pytest -q tests/task_count/test_create_df_task.py(3件成功)
  • 263文書にある698個のコマンド例を引数定義と照合
  • 修正したJSON・jq式・必須引数・サンプルファイル名を検証

Copilot AI balanced review requested due to automatic review settings November 1, 2026 06:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

ドキュメントに、多段検査の2段目以降から差し戻された未着手タスクが、作業時間が閾値以下の場合に never_worked.* に分類される例外が明記されていません。

1 open issue
What changed in this PR

CLIドキュメントの状態分類と実行例を、現在の実装・引数定義に合わせて修正するPRです。実装コードの変更はありません。

変更内容:

  • task_count list_by_phase の状態分類と、作業時間の閾値が適用される条件を明確化。
  • タスク検索条件のJSONと、メタデータ確認用のjq式を修正。
  • 実行例の必須引数と、属性制約のサンプルファイル名を修正。
File Description
docs/​user_guide/​configurations.rst エンドポイント指定例に必須の --project_id を追加。
docs/​command_reference/​task/​reject.rst タスク検索条件のJSON構文を修正。
docs/​command_reference/​task/​change_operator.rst タスク検索条件のJSON構文を修正。
docs/​command_reference/​task_count/​list_by_phase.rst 状態分類と作業時間の閾値の適用条件を明確化。
docs/​command_reference/​input_data/​update_metadata.rst jq式のキーを input_data_id に修正。
docs/​command_reference/​annotation_specs/​add_attribute_restriction.rst 実行例のファイル名を restrictions.json に統一。

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 1, 2026 07:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The supplied review identifies no active issues with the documentation-only changes.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@yuji38kwmt
yuji38kwmt merged commit 6822604 into main Nov 1, 2026
8 checks passed
@yuji38kwmt
yuji38kwmt deleted the docs/fix-implementation-mismatches branch November 1, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants