Update not to use new English() style constructor #19
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
- Recommend `getLanguageBy*` method When LanguageTool supports Java Platform Module System introduced in Java 9, all the language classes should be changed its package path. In order to help users migration smoother, dev document recommends to use Languages.getLanguageBy* utility methods to create Language object in java-api.md. - Explain split package problem in code-style.md - Spell of GitHub trademark Signed-off-by: Hiroshi Miura <[email protected]>
2 tasks
danielnaber
requested changes
Oct 2, 2023
java-api.md
Outdated
| @@ -52,7 +52,7 @@ that accepts the `AnnotatedText` object. | |||
| ## Multi-Threading | |||
|
|
|||
| The `JLanguageTool` class is not thread safe. Create one instance of `JLanguageTool` | |||
| per thread, but create the language only once (e.g. `new BritishEnglish()`) and | |||
| per thread, but create the language only once (e.g. `Languages.getLanguageByName("English (GB)")`) and | |||
There was a problem hiding this comment.
Could you suggest using getLanguageForShortCode("en-GB") here instead? Using the code seems more robust than using the name. (Same for the other occurrences of getLanguageForName)
There was a problem hiding this comment.
Thank you for the suggestion. Because I don't know a preference of "getlanguageFor*" methods, it is welcome to change.
- Use `getlanguageForShortCode` for alternative.
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.
Motivation
A pull-request to support JPMS will change package paths.
A dev document should help developers to be able to migrate smoothly.
Changes
getLanguageBy*method When LanguageTool supports Java Platform Module System introduced in Java 9, all the language classes should be changed its package path. In order to help users migration smoother, dev document recommends to use Languages.getLanguageBy* utility methods to create Language object in java-api.md.