From adcd300fa44e5afd92dd58022ead1fb582c1841b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A1s=20Schmelczer?= <andras@schmelczer.dev>
Date: Sat, 16 Jul 2022 15:35:46 +0200
Subject: [PATCH] Minor docs fixes

---
 .../{large_file.md => large-file.md}          |  0
 great_ai/__init__.py                          |  3 +-
 .../evaluate_ranking/evaluate_ranking.py      |  2 +-
 .../utilities/parallel_map/parallel_map.py    |  2 +-
 mkdocs.yaml                                   | 50 +++++++++----------
 5 files changed, 29 insertions(+), 28 deletions(-)
 rename docs/how-to-guides/{large_file.md => large-file.md} (100%)

diff --git a/docs/how-to-guides/large_file.md b/docs/how-to-guides/large-file.md
similarity index 100%
rename from docs/how-to-guides/large_file.md
rename to docs/how-to-guides/large-file.md
diff --git a/great_ai/__init__.py b/great_ai/__init__.py
index 3dca0bc..7cac9b5 100644
--- a/great_ai/__init__.py
+++ b/great_ai/__init__.py
@@ -1,4 +1,5 @@
-"""GreatAI."""
+"""Transform your prototype AI code into production-ready software."""
+
 __version__ = "0.1.6"
 
 
diff --git a/great_ai/utilities/evaluate_ranking/evaluate_ranking.py b/great_ai/utilities/evaluate_ranking/evaluate_ranking.py
index 38b3a92..4a091cc 100644
--- a/great_ai/utilities/evaluate_ranking/evaluate_ranking.py
+++ b/great_ai/utilities/evaluate_ranking/evaluate_ranking.py
@@ -34,7 +34,7 @@ def evaluate_ranking(
             `expected`)
         title: Title of the plot.
         disable_interpolation: Do not interpolate.
-        axes: Matplotlib axes for ploting inside a subplot.
+        axes: Matplotlib axes for plotting inside a subplot.
         output_svg: If specified, save the chart as an svg to the given Path.
         reverse_order: Reverse the ranking specified by `expected`.
         plot: Display a plot on the screen.
diff --git a/great_ai/utilities/parallel_map/parallel_map.py b/great_ai/utilities/parallel_map/parallel_map.py
index 7571c6e..098d678 100644
--- a/great_ai/utilities/parallel_map/parallel_map.py
+++ b/great_ai/utilities/parallel_map/parallel_map.py
@@ -91,7 +91,7 @@ def parallel_map(
     or ignored.
 
     The new processes are forked if the OS allows it, otherwise, new Python processes
-    are bootstrapped which can incur some start-sup cost. Each process processes a single
+    are bootstrapped which can incur some start-up cost. Each process processes a single
     chunk at once.
 
     Examples:
diff --git a/mkdocs.yaml b/mkdocs.yaml
index 2ef77cf..1f25e09 100644
--- a/mkdocs.yaml
+++ b/mkdocs.yaml
@@ -6,7 +6,7 @@ repo_url: https://github.com/schmelczer/great-ai
 repo_name: schmelczer/great-ai
 edit_uri: edit/main/docs/
 
-copyright: GNU General Public License v3 
+copyright: GNU General Public License v3
 
 extra:
   generator: false
@@ -22,7 +22,7 @@ extra:
       name: great-ai on DockerHub
     - icon: fontawesome/brands/python
       link: https://pypi.org/project/great-ai
-      name:  great-ai on PyPI
+      name: great-ai on PyPI
 
 theme:
   name: "material"
@@ -48,8 +48,8 @@ theme:
         name: Switch to light mode
 
 watch:
-- docs
-- mkdocs.yaml
+  - docs
+  - mkdocs.yaml
 
 plugins:
   - git-revision-date-localized:
@@ -89,27 +89,27 @@ markdown_extensions:
 
 nav:
   - Overview: index.md
-  - Tutorial: 
-    - Tutorial overview: tutorial/index.md
-    - tutorial/train.ipynb
-    - tutorial/deploy.ipynb
+  - Tutorial:
+      - Tutorial overview: tutorial/index.md
+      - tutorial/train.ipynb
+      - tutorial/deploy.ipynb
   - User Guides:
-    - how-to-guides/install.md
-    - how-to-guides/create-service.md
-    - how-to-guides/configure-service.md
-    - how-to-guides/use-service.md
-    - how-to-guides/handle-training-data.md
-    - how-to-guides/large_file.md
-    - how-to-guides/call-remote.md
+      - how-to-guides/install.md
+      - how-to-guides/create-service.md
+      - how-to-guides/configure-service.md
+      - how-to-guides/use-service.md
+      - how-to-guides/handle-training-data.md
+      - how-to-guides/large-file.md
+      - how-to-guides/call-remote.md
   - Reference:
-    - reference/index.md
-    - reference/utilities.md
-    - reference/large-file.md
-    - reference/views.md
-  - Examples: 
-    - Explainable Naive Bayes: 
-      - examples/simple/data.ipynb
-      - examples/simple/train.ipynb
-      - examples/simple/deploy.ipynb
-    - Explainable SciBERT: examples/scibert.md
+      - reference/index.md
+      - reference/utilities.md
+      - reference/large-file.md
+      - reference/views.md
+  - Examples:
+      - Explainable Naive Bayes:
+          - examples/simple/data.ipynb
+          - examples/simple/train.ipynb
+          - examples/simple/deploy.ipynb
+      - Explainable SciBERT: examples/scibert.md
   - explanation.md