Add fixes to documentation

README.md

@@ -14,7 +14,7 @@
 
 ## 1. What does this library do?
 
-Its task is simple: It tells you which language some provided textual data is written in.
+Its task is simple: It tells you which language some text is written in.
 This is very useful as a preprocessing step for linguistic data in natural language
 processing applications such as text classification and spell checking.
 Other use cases, for instance, might include routing e-mails to the right geographically
@@ -1816,7 +1816,7 @@ Erroneously classified as Dutch: 0.20%, Latin: 0.10%
 
 ## 7. How to add it to your project?
 
-    go get github.com/pemistahl/[email protected].0
+    go get github.com/pemistahl/[email protected].1
 
 ## 8. How to build?
 
@@ -1974,7 +1974,7 @@ confidence := detector.ComputeLanguageConfidence("languages are awesome", lingua
 fmt.Printf("%.2f", confidence)
 
 // Output:
-// French: 0.32
+// 0.32
 ```
 
 The value that this method computes is a number between 0.0 and 1.0.

RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+## Lingua 1.1.1 (released on 22 Nov 2022)
+
+### Documentation
+
+- Some documentation mistakes have been fixed and missing information has been added.
+
 ## Lingua 1.1.0 (released on 21 Nov 2022)
 
 ### Features

cmd/go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/abadojack/whatlanggo v1.0.1
 	github.com/jmhodges/gocld3 v0.0.0-20211031064447-cc40e88f7505
-	github.com/pemistahl/lingua-go v1.0.5
+	github.com/pemistahl/lingua-go v1.1.1
 )
 
 require (

doc.go

@@ -19,7 +19,7 @@ Package lingua accurately detects the natural language of written text, be it lo
 
 # What this library does
 
-Its task is simple: It tells you which language some provided textual data is written in.
+Its task is simple: It tells you which language some text is written in.
 This is very useful as a preprocessing step for linguistic data in natural language
 processing applications such as text classification and spell checking.
 Other use cases, for instance, might include routing e-mails to the right geographically
@@ -77,13 +77,7 @@ Whatlanggo running over the data of Lingua's supported 75 languages.
 Additionally, I have added Google's CLD3 (https://github.com/google/cld3/) to the comparison
 with the help of the gocld3 bindings (https://github.com/jmhodges/gocld3). Languages that are not
 supported by CLD3 or Whatlanggo are simply ignored during the detection process.
-
-The bar and box plots (https://github.com/pemistahl/lingua-go/blob/main/ACCURACY_PLOTS.md)
-show the measured accuracy values for all three performed tasks: Single word detection,
-word pair detection and sentence detection. Lingua clearly outperforms its contenders.
-Detailed statistics including mean, median and standard deviation values for each language
-and classifier are available in
-tabular form (https://github.com/pemistahl/lingua-go/blob/main/ACCURACY_TABLE.md) as well.
+Lingua clearly outperforms its contenders.
 
 # Why it is better than other libraries
 

example_test.go

@@ -137,13 +137,10 @@ func Example_eagerLoading() {
 // can become better in such cases if you exclude certain languages from the
 // decision process or just explicitly include relevant languages.
 func Example_builderApi() {
-	// Including all languages available in the library
-	// consumes at least 2GB of memory and might
-	// lead to slow runtime performance.
+	// Include all languages available in the library.
 	lingua.NewLanguageDetectorBuilder().FromAllLanguages()
 
-	// Include only languages that are not yet extinct
-	// (= currently excludes Latin).
+	// Include only languages that are not yet extinct (= currently excludes Latin).
 	lingua.NewLanguageDetectorBuilder().FromAllSpokenLanguages()
 
 	// Include only languages written with Cyrillic script.