docs update

adam-pawelek · Oct 5, 2024 · 14c126d · 14c126d
1 parent 5501b2b
commit 14c126d
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/docs/docs/Tutorial/Choosing OpenAI Model for Translation.md b/docs/docs/Tutorial/Choosing OpenAI Model for Translation.md
@@ -14,7 +14,11 @@ from llmtranslate import TranslatorOpenAI
 
 # Example with a model name as a string
 translator = TranslatorOpenAI(api_key="YOUR_OPENAI_API_KEY", "gpt-4o-mini")
-translated_text = translator.translate("Cześć jak się masz? Meu nome é Adam", "eng")
+
+translated_text = translator.translate(
+    "Cześć jak się masz? Meu nome é Adam", 
+    "eng"
+)
 print(translated_text)
 ```
 
@@ -27,7 +31,11 @@ from llmtranslate import TranslatorOpenAI
 from llmtranslate import ModelForTranslator
 
 # Example using the ModelForTranslator enum
-translator = TranslatorOpenAI(api_key="YOUR_OPENAI_API_KEY", ModelForTranslator.GPT_4o_mini)
+translator = TranslatorOpenAI(
+    api_key="YOUR_OPENAI_API_KEY", 
+    ModelForTranslator.GPT_4o_mini
+)
+
 translated_text = translator.translate("Cześć jak się masz? Meu nome é Adam", "eng")
 print(translated_text)
 ```

diff --git a/docs/docs/Tutorial/Quick Start Guide.md b/docs/docs/Tutorial/Quick Start Guide.md
@@ -57,7 +57,10 @@ from llmtranslate import TranslatorOpenAI
 translator = TranslatorOpenAI(api_key="YOUR_OPENAI_API_KEY")
 
 # Translate text
-translated_text = translator.translate("Cześć jak się masz? Meu nome é Adam", "en")
+translated_text = translator.translate(
+    "Cześć jak się masz? Meu nome é Adam", 
+    "en"
+)
 print(translated_text)  # Output: "Hello how are you? My name is Adam"
 ```
 
@@ -81,7 +84,10 @@ if detected_language is not None:
     print(detected_language.language_name)  # Output 'Polish'
 
 # Translate text
-translated_text = translator.translate("Cześć jak się masz? Meu nome é Adam", "en")
+translated_text = translator.translate(
+    "Cześć jak się masz? Meu nome é Adam", 
+    "en"
+)
 print(translated_text)  # Output: "Hello how are you? My name is Adam"
 
 ```
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "llmtranslate"
-version = "0.3.11"
+version = "0.3.12"
 description = "A Python library for language detection and translation using OpenAI's GPT-4o."
 authors = ["Adam Pawelek <[email protected]>"]
 readme = "README.md"