Updated documentations and fixtures names

Author: shorodilov

src/bisearch/__init__.py

@@ -0,0 +1,19 @@
+"""
+Binary Search
+=============
+
+The binary search algorithm (a.k.a **half-interval search** or **bisect**)
+is a search algorithm that finds the position of a target value within
+a sorted array. The origin dataset is required to be sorted before applying
+to bisect. This algorithm runs in a logarithmic time in the worst case,
+making O(log_n) comparisons.
+
+The general idea is to divide the initial array in two equal portions, and
+to compare the middle value with the requested one. Since array in case
+the middle value is greater than the search one, the left portion can be
+excluded from the future search (vice versa the right one excluded). After
+that the search algorithm is applied for the right part only.
+
+.. seealso:: https://en.wikipedia.org/wiki/Binary_search_algorithm
+
+"""

src/bisearch/prefix.py

@@ -83,6 +83,7 @@ def find_all(origin: List[str], search: str = "") -> List[str]:
 
     :return: the list of strings starting with the search prefix
     :rtype: list[str]
+
     """
 
     try:

tests/bisearch/conftest.py

@@ -9,26 +9,25 @@ def strings_small():
 
 
 @pytest.fixture
-def strings_fixtures():
+def strings_large():
+    # 10_000 strings generated with https://random.org
     fixture_path = Path(__file__).parent.joinpath("fixtures/strings.txt")
     with open(fixture_path) as fixture_file:
         return fixture_file.read().splitlines()
 
 
 @pytest.fixture
-def fa_fixture():
-    return (
-        "ua",
-        ["uaeafwqbag", "uasyolgnuc", "uaszazvdez", "uavmfgakey", "uawwitgssy",
-         "uaxxgxmsrn", "uayppkjtny", ]
-    )
+def find_all_fixture():
+    return ("ua",
+            ["uaeafwqbag", "uasyolgnuc", "uaszazvdez", "uavmfgakey",
+             "uawwitgssy", "uaxxgxmsrn", "uayppkjtny"])
 
 
 @pytest.fixture
-def pr_fixture():
+def prefix_right_fixture():
     return "sh", 7045
 
 
 @pytest.fixture
-def pl_fixture():
+def prefix_left_fixture():
     return "vp", 8291

tests/bisearch/test_prefix.py

@@ -4,19 +4,19 @@
 from bisearch.prefix import NotFound
 
 
-def test_prefix_right(strings_fixtures, pr_fixture):
-    search, test_value = pr_fixture
-    assert prefix.bisect_right(strings_fixtures, search) == test_value
+def test_prefix_right(strings_large, prefix_right_fixture):
+    search, test_value = prefix_right_fixture
+    assert prefix.bisect_right(strings_large, search) == test_value
 
 
-def test_prefix_left(strings_fixtures, pl_fixture):
-    search, test_value = pl_fixture
-    assert prefix.bisect_left(strings_fixtures, search) == test_value
+def test_prefix_left(strings_large, prefix_left_fixture):
+    search, test_value = prefix_left_fixture
+    assert prefix.bisect_left(strings_large, search) == test_value
 
 
-def test_find_all(strings_fixtures, fa_fixture):
-    search, test_value = fa_fixture
-    assert prefix.find_all(strings_fixtures, search) == test_value
+def test_find_all(strings_large, find_all_fixture):
+    search, test_value = find_all_fixture
+    assert prefix.find_all(strings_large, search) == test_value
 
 
 def test_prefix_right_default(strings_small):