Skip to content

docs: README に未記載の Client メソッド2件を追記#284

Merged
rikunosuke merged 2 commits into
mainfrom
docs-add-missing-client-methods-to-readme
Jul 17, 2026
Merged

docs: README に未記載の Client メソッド2件を追記#284
rikunosuke merged 2 commits into
mainfrom
docs-add-missing-client-methods-to-readme

Conversation

@rikunosuke

Copy link
Copy Markdown
Contributor

概要

class Clientfastlabel/__init__.py)と README.md を突き合わせた結果、README に記載が漏れていた public メソッド2件を追記しました。

変更内容

メソッド 対応
find_sequential_pcd_task_by_name 「Find a single task by name」の例が専用メソッドではなく find_sequential_pcd_task(project=..., task_name=...) を使っていたため、他フォーマット(例: find_pcd_task_by_name)と同じく専用メソッドを使う形に修正
get_project_id_slug_map Project セクションの「Get Projects」直後に「Get Projects Id and Slug map」を新規追加。類似の get_task_id_name_map の記載スタイルに準拠

いずれも README 既存のセクション構成・見出しレベル・コードブロックのスタイルに従っています。これで Client の public メソッドはすべて README でカバーされました。

🤖 Generated with Claude Code

- find_sequential_pcd_task_by_name: by name の例を専用メソッドに修正
- get_project_id_slug_map: Get Projects の後に新規追加

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread README.md
Comment on lines 1944 to 1952
```python
task = client.find_sequential_pcd_task(task_id="YOUR_TASK_ID")
```

Find a single task by name.

```python
task = client.find_sequential_pcd_task(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")
tasks = client.find_sequential_pcd_task_by_name(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

おそらくロジック記載ミスと思われるので、修正しています。引数も find_sequential_pcd_task では project/task_name はとらず、これは *_by_name のものでした。

@rikunosuke
rikunosuke requested a review from h-iwata July 17, 2026 01:37
Comment thread README.md Outdated

```python
task = client.find_sequential_pcd_task(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")
tasks = client.find_sequential_pcd_task_by_name(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")

@h-iwata h-iwata Jul 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

返り値がtasks[0]と単数なので、変数名はtaskの方が良さそうですね

ついでに既存のここも直してもらえるとありがたいです

tasks = client.find_pcd_task_by_name(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ありがとうございます!修正しました!

@rikunosuke
rikunosuke requested a review from h-iwata July 17, 2026 04:09
@rikunosuke
rikunosuke merged commit d7e32bf into main Jul 17, 2026
9 checks passed
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