Merged
Conversation
Rewrote the Text and Localization documentation based on a full audit
of the source API. Key changes:
- Restructured all method references into tables for dense scanning
- Verified every method name, parameter order, and return type against
Text.java and Translator.java source
- Added previously undocumented API: localized(key, Locale, args),
tl() overloads, localizePlaceholders overloads, localizePlaceholdersDef,
addResourceBundleFromFolder, Translator.add/get/containsKey/clear/setLocale
- Documented ConfigLocaleReader for YAML-based locale files
- Fixed .properties examples to use correct MessageFormat escaping ('')
- Removed filler comments from code examples
- Added color format comparison table
- Clarified MiniMessage mini: prefix scope (tell/coloredTell/tellLocalized/
coloredTellLocalized only)
- Documented the ignore feature with config.yml usage pattern
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
1 participant
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.
Summary
Text.java,Translator.java,SimpleTranslator.java,Locales.java,BaseSettings.java,BaseManager.java,ConfigLocaleReader.java).localized(key, Locale, args),tl()overloads,localizePlaceholdersoverloads,localizePlaceholdersDef,addResourceBundleFromFolder,Translator.add/get/containsKey/clear/setLocale, andConfigLocaleReaderfor YAML-based locale files..propertiesexamples to use correctMessageFormatescaping (''for literal single quotes). Removed filler comments from all code examples.Test plan