refactor: Added JSDoc comments to exported functions in locales.ts#588
Closed
sidhuiwnl wants to merge 2 commits intolingodotdev:mainfrom
sidhuiwnl:sid/adding-jsdoc
Closed
refactor: Added JSDoc comments to exported functions in locales.ts#588sidhuiwnl wants to merge 2 commits intolingodotdev:mainfrom sidhuiwnl:sid/adding-jsdoc
sidhuiwnl wants to merge 2 commits intolingodotdev:mainfrom
sidhuiwnl:sid/adding-jsdoc
Conversation
sidhuiwnl
changed the title
mathio
suggested changes
Mar 26, 2025
Contributor
mathio
left a comment
mathio
left a comment
There was a problem hiding this comment.
Please keep PRs focused on single issue to make them easier to review. This includes changes for 2 issues.
Contributor
There was a problem hiding this comment.
Only one file in here is needed. Please delete this one.
Comment on lines
+14
to
+15
| .option("--locale <locale>", "Clean up only the specified target locale.If not provided, processes all target locales.") | ||
| .option("--bucket <bucket>", " Clean up only the specified bucket type.If not provided, processes all buckets.") |
Contributor
There was a problem hiding this comment.
Suggested change
| .option("--locale <locale>", "Clean up only the specified target locale.If not provided, processes all target locales.") | |
| .option("--bucket <bucket>", " Clean up only the specified bucket type.If not provided, processes all buckets.") | |
| .option("--locale <locale>", "Clean up only the specified target locale") | |
| .option("--bucket <bucket>", " Clean up only the specified bucket type") |
Lets not make this too verbose.
Comment on lines
+27
to
+34
| .option("--key <key>", "Key to process.Process only a specific translation key. Useful for debugging or updating a single entry.") | ||
| .option("--frozen", `Run in read-only mode - fails if any translations need updating.Useful for CI/CD pipelines to detect missing translations.`) | ||
| .option("--force", "Ignore lockfile and process all keys, forcing a full re-translation.Use with caution as this may incur higher API costs.") | ||
| .option("--verbose", "Show detailed output including intermediate processing data and API communication details.") | ||
| .option("--interactive", "Enable interactive mode for reviewing and editing translations before they are applied.") | ||
| .option("--api-key <api-key>", "Explicitly set the API key to use.Override the default API key from settings.") | ||
| .option("--debug", "Pause execution at start for debugging purposes.Waits for user confirmation before proceeding.") | ||
| .option("--strict", "Stop processing on first error instead of continuing with other locales/buckets.") |
Contributor
There was a problem hiding this comment.
There should be an empty space after period at the end of a sentence when another sentence follows.
Contributor
Author
There was a problem hiding this comment.
i have changed everything you mentioned. can i commit the changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #559