test(FN-3842): align finalize-result assertions and docs

This commit is contained in:
Fusion
2026-05-09 09:11:45 -07:00
committed by gsxdsm
parent a22044b134
commit 8cbbf4761f
2 changed files with 6 additions and 4 deletions

View File

@@ -2558,8 +2558,9 @@ async function buildDeterministicMergeMessage(params: {
* modified are staged. Any other dirty files in the working tree are left
* untouched and a warning is emitted for each one.
*
* Returns true on a successful commit/amend. Never throws — errors are logged
* and the function returns false (callers decide whether to abort the merge).
* Returns a structured result with `{ ok: true, reason: ... }` on success or
* `{ ok: false, reason: ... }` on failure. Never throws — errors are logged and
* callers decide whether to abort the merge based on the returned reason.
*
* @internal Exported for integration tests only — not part of the public API.
*/