Skip to content

Commit

Permalink
docs: improve descriptions for the upload sources command (#752)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar committed Mar 27, 2024
1 parent 0ed1721 commit 6835190
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@
)
class UploadSourcesCommand extends ActCommandWithFiles {

@CommandLine.Option(names = {"-b", "--branch"}, paramLabel = "...", order = -2)
@CommandLine.Option(names = {"-b", "--branch"}, paramLabel = "...", order = -3)
protected String branch;

@CommandLine.Option(names = {"--delete-obsolete"}, descriptionKey = "crowdin.upload.sources.delete-obsolete", order = -2)
protected boolean deleteObsolete;

@CommandLine.Option(names = {"--no-auto-update"}, negatable = true, order = -2)
@CommandLine.Option(names = {"--no-auto-update"}, descriptionKey = "crowdin.upload.sources.no-auto-update", negatable = true, order = -2)
protected boolean autoUpdate = true;

@CommandLine.Option(names = {"--tree"}, descriptionKey = "tree.dryrun", order = -2)
protected boolean treeView;

@CommandLine.Option(names = {"--label"}, descriptionKey = "params.label", paramLabel = "...", order = -2)
@CommandLine.Option(names = {"--label"}, descriptionKey = "params.label", paramLabel = "...", order = -3)
protected List<String> labels;

@CommandLine.Option(names = {"--excluded-language"}, descriptionKey = "params.excluded-languages", paramLabel = "...", order = -2)
protected List<String> excludedLanguages;

@CommandLine.Option(names = {"--dryrun"})
@CommandLine.Option(names = {"--tree"}, descriptionKey = "tree.dryrun")
protected boolean treeView;

@CommandLine.Option(names = {"--dryrun"}, descriptionKey = "dryrun")
protected boolean dryrun;

@CommandLine.Option(names = {"--plain"}, descriptionKey = "crowdin.list.usage.plain")
Expand Down
7 changes: 3 additions & 4 deletions src/main/resources/messages/messages.properties
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ params.skipUntranslatedFiles=Omit downloading not fully translated files
params.keepArchive=Do not remove the downloaded archive with translations after it's extracting
params.exportOnlyApproved=Include approved translations only in exported files. If not combined with --skip-untranslated-strings option, strings without approval are fulfilled with the source language
params.label=Attach labels to strings (multiple labels can be specified)
params.excluded-languages=Specify excluded languages (multiple languages could be specified)
params.excluded-languages=Specify languages the sources should not be translated into. Can be specified multiple times
params.reviewedSources=Download only reviewed sources (Crowdin Enterprise only)

dryrun=Print a command output without execution
Expand Down Expand Up @@ -105,13 +105,12 @@ crowdin.usage.customSynopsis=@|fg(green) crowdin|@ [SUBCOMMAND] [OPTIONS]
# CROWDIN UPLOAD SOURCES COMMAND
crowdin.upload.sources.usage.description=Upload source files to a Crowdin project
crowdin.upload.sources.usage.customSynopsis=@|fg(green) crowdin |@(@|fg(green) upload|@|@|fg(green) push|@) @|fg(green) sources|@ [CONFIG OPTIONS] [OPTIONS]
crowdin.upload.sources.no-auto-update=Choose whether or not to update the source files in your Crowdin project. Use this option if you want to upload new source files without updating the existing ones.
crowdin.upload.sources.delete-obsolete=Delete obsolete files and folders from Crowdin project
crowdin.upload.sources.no-auto-update=Specify whether to update existing source files in the Crowdin project or only upload new ones. Updates by default
crowdin.upload.sources.delete-obsolete=Delete obsolete files and folders from the Crowdin project that no longer match the source configuration or have been deleted locally

# CROWDIN UPLOAD COMMAND
crowdin.upload.usage.description=Upload source files to a Crowdin project
crowdin.upload.usage.customSynopsis=@|fg(green) crowdin |@(@|fg(green) upload|@|@|fg(green) push|@) [SUBCOMMAND] [CONFIG OPTIONS] [OPTIONS]
crowdin.upload.no-auto-update=Choose whether or not to update the source files in your Crowdin project. Use this option if you want to upload new source files without updating the existing ones.

# CROWDIN UPLOAD TRANSLATIONS COMMAND
crowdin.upload.translations.usage.description=Upload existing translations to your Crowdin project
Expand Down

0 comments on commit 6835190

Please sign in to comment.