Merge branch 'master' into fix-reverse-bits

Author: MaximSmolskiy

README.md

@@ -27,8 +27,8 @@
   <a href="https://github.com/pre-commit/pre-commit">
     <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit">
   </a>
-  <a href="https://github.com/psf/black">
-    <img src="https://img.shields.io/static/v1?label=code%20style&message=black&color=black&style=flat-square" height="20" alt="code style: black">
+  <a href="https://docs.astral.sh/ruff/formatter/">
+    <img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: black">
   </a>
 <!-- Short description: -->
   <h3>All algorithms implemented in Python - for education</h3>

scripts/build_directory_md.py

@@ -18,8 +18,20 @@ def good_file_paths(top_dir: str = ".") -> Iterator[str]:
                 yield os.path.join(dir_path, filename).lstrip("./")
 
 
-def md_prefix(i):
-    return f"{i * '  '}*" if i else "\n##"
+def md_prefix(indent: int) -> str:
+    """
+    Markdown prefix based on indent for bullet points
+
+    >>> md_prefix(0)
+    '\\n##'
+    >>> md_prefix(1)
+    '  *'
+    >>> md_prefix(2)
+    '    *'
+    >>> md_prefix(3)
+    '      *'
+    """
+    return f"{indent * '  '}*" if indent else "\n##"
 
 
 def print_path(old_path: str, new_path: str) -> str: