Changeset 10 in code for trunk/engines/libretranslate.go

Timestamp:

Sep 30, 2022, 8:16:23 PM (3 years ago)

Author:

fattalion

Message:

Make some identifiers more concise

See ​https://go.dev/doc/effective_go#package-names, specifically:

The importer of a package will use the name to refer to its contents,
so exported names in the package can use that fact to avoid
repetition.

For example, engines.GoogleTranslateEngine needlessly repeats
"engine," so just get rid of that duplication by renaming it to
engines.GoogleTranslate.

Renaming engines.TranslationEngine to engines.Engine may be
debatable, so if somebody disagrees, feel free to leave a comment
stating your disagreement and with an explanation of why you disagree.

File:

• trunk/engines/libretranslate.go (modified) (6 diffs)

trunk/engines/libretranslate.go

@@ -8 +8 @@
 )
 
-// LibreTranslateEngine is an engine that interfaces with any
+// LibreTranslate is an engine that interfaces with any
 // [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) instance.
-type LibreTranslateEngine struct {
+type LibreTranslate struct {
         // InstanceURL is the URL to a LibreTranslate instance, for instance
         // "https://libretranslate.com".
@@ -24 +24 @@
 }
 
-func (_ *LibreTranslateEngine) InternalName() string { return "libre" }
+func (_ *LibreTranslate) InternalName() string { return "libre" }
 
-func (_ *LibreTranslateEngine) DisplayName() string { return "LibreTranslate" }
+func (_ *LibreTranslate) DisplayName() string { return "LibreTranslate" }
 
 type libreLanguagesResponse []struct {
@@ -33 +33 @@
 }
 
-func (e *LibreTranslateEngine) getLangs() ([]Language, error) {
+func (e *LibreTranslate) getLangs() ([]Language, error) {
         response, err := http.Get(e.InstanceURL + "/languages")
 
@@ -62 +62 @@
 }
 
-func (e *LibreTranslateEngine) SourceLanguages() ([]Language, error) { return e.getLangs() }
+func (e *LibreTranslate) SourceLanguages() ([]Language, error) { return e.getLangs() }
 
-func (e *LibreTranslateEngine) TargetLanguages() ([]Language, error) { return e.getLangs() }
+func (e *LibreTranslate) TargetLanguages() ([]Language, error) { return e.getLangs() }
 
-func (_ *LibreTranslateEngine) SupportsAutodetect() bool { return true }
+func (_ *LibreTranslate) SupportsAutodetect() bool { return true }
 
 type libreDetectResponse []struct {
@@ -73 +73 @@
 }
 
-func (e *LibreTranslateEngine) DetectLanguage(text string) (Language, error) {
+func (e *LibreTranslate) DetectLanguage(text string) (Language, error) {
         formData := map[string]string{"q": text}
 
@@ -131 +131 @@
 }
 
-func (e *LibreTranslateEngine) Translate(text string, from Language, to Language) (TranslationResult, error) {
+func (e *LibreTranslate) Translate(text string, from Language, to Language) (TranslationResult, error) {
         formData := map[string]string{
                 "q":      text,