Apply suggestions from code review

Co-authored-by: Jakub Drobník <drobnik.j@gmail.com>
apify · Jul 31, 2024 · bae5750 · bae5750
1 parent 57d647b
commit bae5750
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ pip install apify-haystack
 
 ## Examples
 
-Crawl website using Apify Website Content Crawler and convert it to Haystack Documents.
+### Crawl a website Using Apify Website Content Crawler and convert it to Haystack Documents
 
 You need to have an Apify account and API token to run this example.
 You can start with a free account at [Apify](https://apify.com/) and get your [API token](https://docs.apify.com/platform/integrations/api).
@@ -57,6 +57,8 @@ for d in dataset:
     print(d)
 ```
 
+### More Examples
+
 See other examples in the [examples directory](https://github.com/apify/apify-haystack/blob/master/src/apify_haystack/examples) for more examples, here is a list of few of them
 
 - Load a dataset from Apify and convert it to Haystack Document

diff --git a/src/apify_haystack/examples/crawl_and_process_data.py b/src/apify_haystack/examples/crawl_and_process_data.py
@@ -30,7 +30,7 @@
 
 load_dotenv()
 
-# Set APIFY-API-TOKEN here or use it from .env file
+# Set APIFY_API_TOKEN here or use it from .env file
 apify_api_token = "" or os.getenv("APIFY_API_TOKEN")
 openai_api_key = "" or os.getenv("OPENAI_API_KEY")
 

diff --git a/src/apify_haystack/examples/rag_with_crawled_website.py b/src/apify_haystack/examples/rag_with_crawled_website.py
@@ -31,7 +31,7 @@
 
 from apify_haystack import ApifyDatasetFromActorCall
 
-# Set APIFY-API-TOKEN here or use it from .env file
+# Set APIFY_API_TOKEN here or use it from .env file
 load_dotenv()
 apify_api_token = "" or os.getenv("APIFY_API_TOKEN")
 openai_api_key = "" or os.getenv("OPENAI_API_KEY")