Repository navigation
docs: 実装と異なる状態分類の説明と実行例を修正 - #1941
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

タスク数集計の説明と実行例に、現在の実装と一致しない記述がありました。
task_count list_by_phaseの状態分類と作業時間の閾値が適用される条件を明記し、タスク検索条件のJSON、メタデータ確認のjq式、エンドポイント指定例の必須引数、属性制約のサンプルファイル名を修正します。検証:
make formatmake lintmake docs-check(警告なし)pytest -q tests/task_count/test_create_df_task.py(3件成功)