Make SlashCommand#getHelp() return translated text when available. #90
Conversation
This file contains 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
Chew
reviewed
Jul 26, 2024
| helpMessage = getDescriptionLocalization().get(TranslateUtil.getDefaultLocale()); | ||
| } | ||
|
|
||
| return (helpMessage == null || helpMessage.isEmpty()) ? this.help : helpMessage; |
There was a problem hiding this comment.
We should always return this.help if it is specified, and only do this logic if it's not
There was a problem hiding this comment.
Sorry for a late reply... Honestly forgot this.
The main issue is, that help is always there. By default is it no help available, so if we should have this logic will this require modifications to the default help message (i.e. make it null and have getHelp() return the default text in case of null), which I feel like a breaking change here.
Maybe another aproach could be a dedicated option and getter for the command description for slash commands that defaults to returning getHelp() if nothing is set?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request
Pull Request Checklist
Please follow the following steps before opening this PR.
PRs that do not complete the checklist will be subject to denial for
missing information.
or merged features/bug fixes.
Pull Request Information
Check and fill in the blanks for all that apply:
commandsmodule of the JDA-Utilities library.______.Description
This overrides the
getHelp()method to return a translated description using the default locale throughgetDescriptionLocalization().get(TranslateUtil.getDefaultLocale)This should allow a user to set the description within the localization files without needing to set the
helptext itself.Should there be no localized description for the default locale (Be null or empty) will it default to using
this.helpThis also adds
getDefaultLocale()in the TranslateUtil to retrieve the default locale that was set.I didn't add the same functionality to the name, as names in SlashCommands need to be alphanummeric when creating, which with this aproach would be problematic.
Given that this overrides a method for SlashCommand, should it automatically also be applied to Subcommands too.
Closes #89