Rename documentation to marqo_docs

marqo-ai · Feb 1, 2024 · c5e2637 · c5e2637
1 parent 1ad3d51
commit c5e2637
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/src/marqo/documentation.py → src/marqo/marqo_docs.py b/src/marqo/documentation.py → src/marqo/marqo_docs.py
diff --git a/src/marqo/tensor_search/index_meta_cache.py b/src/marqo/tensor_search/index_meta_cache.py
@@ -7,7 +7,7 @@
 import time
 from typing import Dict
 
-from marqo import documentation
+from marqo import marqo_docs
 from marqo.api import exceptions
 from marqo.config import Config
 from marqo.core.exceptions import IndexNotFoundError
@@ -114,7 +114,7 @@ def refresh():
                             logger.warn(
                                 "Failed to connect to vector store. If you are using an external vector store, "
                                 "ensure that Marqo is configured properly for this. See "
-                                f"{documentation.configuring_marqo()} for more details. Error: {e}"
+                                f"{marqo_docs.configuring_marqo()} for more details. Error: {e}"
                             )
                     except Exception as e:
                         logger.error(f'Unexpected error in index cache refresh thread: {e}')

diff --git a/src/marqo/tensor_search/on_start_script.py b/src/marqo/tensor_search/on_start_script.py
@@ -4,7 +4,7 @@
 
 import torch
 
-from marqo import config, documentation, version
+from marqo import config, marqo_docs, version
 from marqo.api import exceptions
 from marqo.connections import redis_driver
 from marqo.s2_inference.s2_inference import vectorise
@@ -54,7 +54,7 @@ def run(self):
             logger.warn(
                 f"Could not create Marqo settings schema. If you are using an external vector store, "
                 "ensure that Marqo is configured properly for this. See "
-                f"{documentation.configuring_marqo()} for more details. Error: {e}"
+                f"{marqo_docs.configuring_marqo()} for more details. Error: {e}"
             )
 
 

diff --git a/tests/test_documentation.py b/tests/test_documentation.py
@@ -2,19 +2,19 @@
 
 import httpx
 
-from marqo import documentation
+from marqo import marqo_docs
 
 
 class TestDocumentation(unittest.TestCase):
     def test_urls(self):
         # Retrieve all public functions in the module
-        public_functions = [func for func in dir(documentation)
-                            if callable(getattr(documentation, func)) and not func.startswith("_")]
+        public_functions = [func for func in dir(marqo_docs)
+                            if callable(getattr(marqo_docs, func)) and not func.startswith("_")]
 
         # Verify all URLs return a 200 response
         for func in public_functions:
             with self.subTest(func=func):
-                url = getattr(documentation, func)()
+                url = getattr(marqo_docs, func)()
                 response = httpx.get(url, follow_redirects=True)
                 response.raise_for_status()
                 self.assertFalse('404.html' in response.content.decode(), f"{func} URL returned a 404 response")