From eea9472757587701a34713475bd8262478c42e2f Mon Sep 17 00:00:00 2001 From: geruh Date: Fri, 21 Aug 2026 01:48:13 -0700 Subject: [PATCH] chore: format cherry_pick and regen typedoc order Python lint failed on the wrapped async signature. Node docs check failed because typedoc sorts methods, globals, and union members. --- docs/src/js/classes/Branches.md | 50 +++++++++++----------- docs/src/js/globals.md | 6 +-- docs/src/js/interfaces/BranchDiff.md | 16 +++---- docs/src/js/interfaces/CherryPickResult.md | 2 +- python/python/lancedb/table.py | 4 +- 5 files changed, 40 insertions(+), 38 deletions(-) diff --git a/docs/src/js/classes/Branches.md b/docs/src/js/classes/Branches.md index 46983eb7c..6680fbfee 100644 --- a/docs/src/js/classes/Branches.md +++ b/docs/src/js/classes/Branches.md @@ -37,6 +37,31 @@ latest and stays writable. *** +### cherryPick() + +```ts +cherryPick(fromBranch, dryRun): Promise +``` + +Cherry-pick a branch onto main. + +Set `dryRun` to `true` to preview. A failed cherry-pick resolves +with `status: "failed"` instead of throwing. + +#### Parameters + +* **fromBranch**: `string` + Branch to cherry-pick from. + +* **dryRun**: `boolean` = `false` + When true, only preview. Defaults to false. + +#### Returns + +`Promise`<[`CherryPickResult`](../interfaces/CherryPickResult.md)> + +*** + ### create() ```ts @@ -112,28 +137,3 @@ List all branches, mapping name to branch metadata. #### Returns `Promise`<`Record`<`string`, [`BranchContents`](BranchContents.md)>> - -*** - -### cherryPick() - -```ts -cherryPick(fromBranch, dryRun): Promise -``` - -Cherry-pick a branch onto main. - -Set `dryRun` to `true` to preview. A failed cherry-pick resolves -with `status: "failed"` instead of throwing. - -#### Parameters - -* **fromBranch**: `string` - Branch to cherry-pick from. - -* **dryRun**: `boolean` = `false` - When true, only preview. Defaults to false. - -#### Returns - -`Promise`<[`CherryPickResult`](../interfaces/CherryPickResult.md)> diff --git a/docs/src/js/globals.md b/docs/src/js/globals.md index 8ce1d4c84..4deeed1bc 100644 --- a/docs/src/js/globals.md +++ b/docs/src/js/globals.md @@ -59,6 +59,9 @@ - [BranchIndexSummary](interfaces/BranchIndexSummary.md) - [BranchRowCountSummary](interfaces/BranchRowCountSummary.md) - [BucketStats](interfaces/BucketStats.md) +- [CherryPickError](interfaces/CherryPickError.md) +- [CherryPickPreview](interfaces/CherryPickPreview.md) +- [CherryPickResult](interfaces/CherryPickResult.md) - [ClientConfig](interfaces/ClientConfig.md) - [ColumnAlteration](interfaces/ColumnAlteration.md) - [ColumnOrdering](interfaces/ColumnOrdering.md) @@ -99,9 +102,6 @@ - [LsmStats](interfaces/LsmStats.md) - [LsmWriteSpec](interfaces/LsmWriteSpec.md) - [MemtableStats](interfaces/MemtableStats.md) -- [CherryPickError](interfaces/CherryPickError.md) -- [CherryPickResult](interfaces/CherryPickResult.md) -- [CherryPickPreview](interfaces/CherryPickPreview.md) - [MergeResult](interfaces/MergeResult.md) - [NativeOAuthConfig](interfaces/NativeOAuthConfig.md) - [OAuthConfig](interfaces/OAuthConfig.md) diff --git a/docs/src/js/interfaces/BranchDiff.md b/docs/src/js/interfaces/BranchDiff.md index 819d7cac1..b408ebe11 100644 --- a/docs/src/js/interfaces/BranchDiff.md +++ b/docs/src/js/interfaces/BranchDiff.md @@ -50,6 +50,14 @@ changedColumns: BranchColumnChange[]; *** +### errors + +```ts +errors: CherryPickError[]; +``` + +*** + ### fromBranch ```ts @@ -66,14 +74,6 @@ mainVersion: number; *** -### errors - -```ts -errors: CherryPickError[]; -``` - -*** - ### parentVersion ```ts diff --git a/docs/src/js/interfaces/CherryPickResult.md b/docs/src/js/interfaces/CherryPickResult.md index 81f5c3992..c837ab143 100644 --- a/docs/src/js/interfaces/CherryPickResult.md +++ b/docs/src/js/interfaces/CherryPickResult.md @@ -38,8 +38,8 @@ preview: CherryPickPreview; ```ts status: - | "unknown" | "failed" + | "unknown" | "ready" | "notImplemented" | "cherryPicked"; diff --git a/python/python/lancedb/table.py b/python/python/lancedb/table.py index 6fa1309b6..0c84b4036 100644 --- a/python/python/lancedb/table.py +++ b/python/python/lancedb/table.py @@ -6951,7 +6951,9 @@ class AsyncBranches: """Diff a branch against main.""" return await self._table.branches.diff(from_branch) - async def cherry_pick(self, from_branch: str, dry_run: bool = False) -> Dict[str, Any]: + async def cherry_pick( + self, from_branch: str, dry_run: bool = False + ) -> Dict[str, Any]: """Cherry-pick a branch onto main, or dry-run. A failed cherry-pick returns ``status="failed"`` instead of raising.