From 9ddb0272bf58f681b0b2b25650464f87ecfea742 Mon Sep 17 00:00:00 2001 From: Diya <149782916+diya94@users.noreply.github.com> Date: Sun, 24 Aug 2025 16:52:00 +0530 Subject: [PATCH] Adding doctest for md_prefix function in build_directory_md.py (#12874) * Adding doctests for md_prefix function in build_directory_md.py * Update build_directory_md.py * Update build_directory_md.py * Update build_directory_md.py --------- Co-authored-by: Maxim Smolskiy --- scripts/build_directory_md.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/scripts/build_directory_md.py b/scripts/build_directory_md.py index aa95b95db..bdad7686c 100755 --- a/scripts/build_directory_md.py +++ b/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: