Merge pull request #122 from jacobp24/examples_typo

fixed two typos
jacobp24 · Mar 13, 2024 · 028368c · 028368c
2 parents 2922ba1 + 2a48a17
commit 028368c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/build_test.yml b/.github/workflows/build_test.yml
@@ -94,6 +94,8 @@ jobs:
         run: |
           pylint bookworm/*.py
           pylint bookworm/**/*.py
+          pylint scripts/*.py
+          
 
 
       # Next step: run the unit tests with code coverage.

diff --git a/examples/README.md b/examples/README.md
@@ -30,7 +30,7 @@ Here is an example when you input Agatha Christie:
 
 ![Author-1](walkthrough_images/walkthrough_image1.jpg)
 
-OR There is an option "Most popular books by my favorite author" which generates recommened books only within that
+OR There is an option "Most popular books by my favorite author" which generates recommended books only within that
 requested author, sorted by a user-rating analysis.  Use the sliders at the bottom to exclude books that have lower ratings or not many reviews. Keep in mind
 this may return less than 10 results. 
 
@@ -48,7 +48,7 @@ Users can also input a description of a book they enjoyed and our model will giv
 Click on the "Books similar to my favorite plot" option, and search away!
     (Please be patient, it is doing work behind the scenes!)
 
-For example: You could search for "dectives solve murders from long ago"
+For example: You could search for "detectives solve murders from long ago"
 
 ![Plot1](walkthrough_images/WalkthroughImage6.png)
 

diff --git a/scripts/Embeddings.py b/scripts/Embeddings.py
@@ -1,5 +1,5 @@
 # Needed to do this for the use of a general exception to deal with broad API errors.
-# pylint: disable=W0718,W0621
+# pylint: disable=W0718,W0621,E0401,C0103
 """
 This script processes a dataset of book summaries to generate and utilize embeddings
 for semantic analysis, leveraging the voyageai API for embedding generation.

diff --git a/scripts/__init__.py b/scripts/__init__.py
@@ -1,3 +1,7 @@
+"""
+Initializes API KEY in the init
+"""
+
 import os
 from dotenv import load_dotenv