final touches to documentation

jgeysen · May 21, 2021 · 2929c49 · 2929c49
1 parent 25bf50d
commit 2929c49
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -13,7 +13,7 @@ Installation:
 Installation from source:
 =====================
 
-The source for Eigen_Tech_NLP_Project can be downloaded from the `Github repo`_:
+The source for Eigen_Tech_NLP_Project can be downloaded from this `Github repo`_:
 
 Clone the public repository:
 
@@ -72,6 +72,12 @@ To activate the environment, again from the root directory of the repo:
 
     pipenv shell
 
+To create and view the documentation:
+
+.. code-block:: console
+
+    pipenv run make_docs
+
 
 .. |GitHub Test| image:: https://github.com/jgeysen/eigen_tech_project/workflows/Test/badge.svg
    :target: https://github.com/jgeysen/eigen_tech_project/actions

diff --git a/eigen_tech_project/inverted_index.py b/eigen_tech_project/inverted_index.py
@@ -155,7 +155,7 @@ def lemma_frequencies(self) -> List:
         """Returns a list of integers, representing the frequency that each
         word occurs in the vocabulary.
 
-        The position of each integer in this list corresponds a lemma in the
+        The position of each integer in this list corresponds to a lemma in the
         alphabetical vocabulary list (with the same respective position). The integers represent the frequency
         a lemma occurs in the entire corpus (across sentences and files).