Skip to content

Commit f36191b

Browse files
committed
docs: consistency
1 parent 0262814 commit f36191b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/LingoDotDevEngine.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public function __construct(array $config = [])
167167
* - 'targetLocale' (string, required): Language code to translate into (e.g., 'es', 'fr')
168168
* - 'sourceLocale' (string|null): Language code of original text, null for auto-detection
169169
* - 'fast' (bool): Trade translation quality for speed
170-
* - 'reference' (array<string, mixed>|null): Context or glossary terms to guide translation
170+
* - 'reference' (array<string, mixed>|null): Context data or glossary terms to guide translation
171171
* @param null|callable(int, mixed, mixed): void $progressCallback Callback invoked with completion percentage (0-100), current chunk, and processed chunk
172172
*
173173
* @return array<string, mixed> Translated content maintaining original structure
@@ -225,7 +225,7 @@ protected function localizeRaw(array $payload, array $params, ?callable $progres
225225
* @param string $targetLocale Language code to translate into (e.g., 'fr', 'de')
226226
* @param array<string, mixed> $payload Content chunk with optional reference data for context:
227227
* - 'data' (array<string, mixed>): Chunk data submitted for translation
228-
* - 'reference' (array<string, mixed>|null): Additional context for the translation request
228+
* - 'reference' (array<string, mixed>|null): Context data or glossary terms to guide translation
229229
* @param string $workflowId Unique identifier for tracking related translation requests
230230
* @param bool $fast Enable faster translation at potential quality tradeoff
231231
*
@@ -372,7 +372,7 @@ private function _createId(): string
372372
* - 'targetLocale' (string, required): Language code to translate into (e.g., 'es', 'fr')
373373
* - 'sourceLocale' (string|null): Language code of original text, null for auto-detection
374374
* - 'fast' (bool): Trade translation quality for speed
375-
* - 'reference' (array<string, mixed>|null): Context or glossary terms to guide translation
375+
* - 'reference' (array<string, mixed>|null): Context data or glossary terms to guide translation
376376
* @param null|callable(int, mixed, mixed): void $progressCallback Invoked per batch with (percentage complete, current batch, translated batch)
377377
*
378378
* @return array<string, mixed> Translated data preserving original structure and non-text values
@@ -430,7 +430,7 @@ public function localizeObject(array $obj, array $params, ?callable $progressCal
430430
* - 'targetLocale' (string, required): Language code to translate into (e.g., 'es', 'fr')
431431
* - 'sourceLocale' (string|null): Language code of original text, null for auto-detection
432432
* - 'fast' (bool): Trade translation quality for speed
433-
* - 'reference' (array<string, mixed>|null): Context, terminology, or style guidelines
433+
* - 'reference' (array<string, mixed>|null): Context data or glossary terms to guide translation
434434
* @param null|callable(int): void $progressCallback Called with completion percentage (0-100) during processing
435435
*
436436
* @return string Translated text, or empty string if translation unavailable
@@ -571,7 +571,7 @@ public function localizeText(string $text, array $params, ?callable $progressCal
571571
* @param array<string, mixed> $params Batch translation options shared by all target locales:
572572
* - 'sourceLocale' (string, required): Language code of the original text (e.g., 'en')
573573
* - 'targetLocales' (string[], required): Array of language codes to translate into (e.g., ['es', 'fr', 'de'])
574-
* - 'fast' (bool): Apply speed optimization to all translations
574+
* - 'fast' (bool): Trade translation quality for speed
575575
*
576576
* @return string[] Array of translated texts in same order as targetLocales parameter
577577
*
@@ -631,8 +631,8 @@ public function batchLocalizeText(string $text, array $params): array
631631
* @param array<string, mixed> $params Chat translation options defining locale behavior and context:
632632
* - 'targetLocale' (string, required): Language code to translate messages into (e.g., 'es', 'fr')
633633
* - 'sourceLocale' (string|null): Language code of original messages, null for auto-detection
634-
* - 'fast' (bool): Optimize for speed over translation quality
635-
* - 'reference' (array<string, mixed>|null): Conversation context or domain-specific terminology
634+
* - 'fast' (bool): Trade translation quality for speed
635+
* - 'reference' (array<string, mixed>|null): Context data or glossary terms to guide translation
636636
* @param null|callable(int): void $progressCallback Called with completion percentage (0-100) during processing
637637
*
638638
* @return array<int, array<string, string>> Translated messages keeping original speaker names unchanged

0 commit comments

Comments
 (0)