Commit 926503e
committed
docs(backups): add backup_id provenance hint in create_index_from_backup
## Purpose
Users calling `create_index_from_backup` have no indication of how to
obtain a valid `backup_id`, which is a required parameter with no
obvious default. Missing navigation hint violates the convention that
second-step methods must reference their prerequisites.
## Solution
Added a one-sentence prose reference to the `backup_id` parameter
description in both the sync (`Pinecone`) and async (`AsyncPinecone`)
clients pointing to `backups.create` and `backups.list` as the two
canonical sources for a backup identifier. Chose prose over inline
workflow example to keep the docstring focused on this method.1 parent 4622a1c commit 926503e
2 files changed
Lines changed: 4 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
474 | 474 | | |
475 | 475 | | |
476 | 476 | | |
477 | | - | |
| 477 | + | |
| 478 | + | |
478 | 479 | | |
479 | 480 | | |
480 | 481 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
368 | 368 | | |
369 | 369 | | |
370 | 370 | | |
371 | | - | |
| 371 | + | |
| 372 | + | |
372 | 373 | | |
373 | 374 | | |
374 | 375 | | |
| |||
0 commit comments